Skip to content

Bevy Input Docs : the modules#9467

Merged
alice-i-cecile merged 3 commits intobevyengine:mainfrom
tguichaoua:docs/bevy_input/modules
Aug 23, 2023
Merged

Bevy Input Docs : the modules#9467
alice-i-cecile merged 3 commits intobevyengine:mainfrom
tguichaoua:docs/bevy_input/modules

Conversation

@tguichaoua
Copy link
Contributor

@tguichaoua tguichaoua commented Aug 17, 2023

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.

This was referenced Aug 17, 2023
@github-actions
Copy link
Contributor

Example alien_cake_addict failed to run, please try running it locally and check the result.

Copy link
Contributor

@killercup killercup left a 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.
Copy link
Contributor

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?

Copy link
Contributor Author

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.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Input Player input via keyboard, mouse, gamepad, and more labels Aug 17, 2023
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 19, 2023
@alice-i-cecile
Copy link
Member

Can you add warn(missing_docs) to the crate in this PR and then I'll merge them all in order for you?

@tguichaoua
Copy link
Contributor Author

@alice-i-cecile Done 👌

@alice-i-cecile
Copy link
Member

Alright, let's see if that works via the merge queue! I'll do them sequentially if it fails.

github-merge-queue bot pushed a commit that referenced this pull request Aug 19, 2023
# 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 <killercup@gmail.com>
github-merge-queue bot pushed a commit that referenced this pull request Aug 19, 2023
# 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 <killercup@gmail.com>
@alice-i-cecile
Copy link
Member

Alright, let's see if this passes now that the other two PRs are merged.

auto-merge was automatically disabled August 23, 2023 07:15

Head branch was pushed to by a user without write access

@tguichaoua
Copy link
Contributor Author

@alice-i-cecile
Auto-merge fails because of a conflict, should be fixed now.

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 23, 2023
Merged via the queue into bevyengine:main with commit 20c85b5 Aug 23, 2023
@tguichaoua tguichaoua deleted the docs/bevy_input/modules branch August 23, 2023 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Input Player input via keyboard, mouse, gamepad, and more C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants