-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bevy Input Docs : the modules #9467
Bevy Input Docs : the modules #9467
Conversation
Example |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Always nice to see more docs :) I would ask for more examples to see what this is used for but I don't think the module docs are the right place necessarily
@@ -1,3 +1,5 @@ | |||
//! The generic axis type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand the module docs are not very important but this tells me about as much as the name of the module 😅 What is this axis type used for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see what to put here since items of the modules already have relevant docs.
This docs is only here for being able to add #![warn(missing_docs)]
on bevy_input
.
Can you add |
@alice-i-cecile Done 👌 |
Alright, let's see if that works via the merge queue! I'll do them sequentially if it fails. |
# Objective Complete the documentation of `bevy_input` (#3492). This PR is part of a triptych of PRs : - #9467 - #9469 ## Solution Add missing documentation on items in `lib.rs`. --------- Co-authored-by: Pascal Hertleif <[email protected]>
# Objective Complete the documentation of `bevy_input` (#3492). This PR is part of a triptych of PRs : - #9467 - #9468 ## Solution Add missing documentation on items in `gamepad.rs` --------- Co-authored-by: Pascal Hertleif <[email protected]>
Alright, let's see if this passes now that the other two PRs are merged. |
Head branch was pushed to by a user without write access
@alice-i-cecile |
Objective
Complete the documentation of
bevy_input
(#3492).This PR is part of a triptych of PRs :
Solution
Add documentation on modules in
bevy_input
.