Skip to content
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

Docstrings for enum bevy_app::CoreStage are not consistent #2806

Closed
alterae opened this issue Sep 11, 2021 · 2 comments
Closed

Docstrings for enum bevy_app::CoreStage are not consistent #2806

alterae opened this issue Sep 11, 2021 · 2 comments
Labels
A-App Bevy apps and plugins C-Docs An addition or correction to our documentation

Comments

@alterae
Copy link

alterae commented Sep 11, 2021

How can Bevy's documentation be improved?

All the other docstrings for the variants use the phrasing "Name of app stage X", while the docstring for CoreStage::Startup simply describes the stage.

While I personally am not a fan of the "Name of app stage" phrasing, if it is being used it should be used consistently.

Phrasing of either the Startup docstring or the other docstrings should be adjusted to match. Probably Startup should be changed in order to match both the other variants of CoreStage and the docstrings for StartupStage.

Relevant source code

/// The names of the default App stages
#[derive(Debug, Hash, PartialEq, Eq, Clone, StageLabel)]
pub enum CoreStage {
/// Runs once at the beginning of the app.
Startup,
/// Name of app stage that runs before all other app stages
First,
/// Name of app stage responsible for performing setup before an update. Runs before UPDATE.
PreUpdate,
/// Name of app stage responsible for doing most app logic. Systems should be registered here
/// by default.
Update,
/// Name of app stage responsible for processing the results of UPDATE. Runs after UPDATE.
PostUpdate,
/// Name of app stage that runs after all other app stages
Last,
}

@alterae alterae added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Sep 11, 2021
@alterae
Copy link
Author

alterae commented Sep 11, 2021

I did not realize this while I was writing this issue but PR #2434 renders this issue meaningless by removing the enum variant in question.

@DJMcNab DJMcNab added A-App Bevy apps and plugins and removed S-Needs-Triage This issue needs to be labelled labels Sep 12, 2021
@alice-i-cecile
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-App Bevy apps and plugins C-Docs An addition or correction to our documentation
Projects
None yet
Development

No branches or pull requests

3 participants