Skip to content

Add missing doc comments to system_information_diagnostics_plugin #19267

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

theotherphil
Copy link
Contributor

Objective

More trivial doc comments towards being able to deny missing docs across the board.

@theotherphil theotherphil added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy labels May 17, 2025
@janhohenheim janhohenheim added S-Needs-Review Needs reviewer attention (from anyone!) to move forward A-Diagnostics Logging, crash handling, error reporting and performance analysis labels May 18, 2025
pub kernel: String,
/// CPU brand, for example 'Apple M1 Max'.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that's a real-world example? i.e. this string looks exactly like that on a real M1 Max?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I wasn't sure what this was so ran it on my laptop and copied the output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Needs-Review Needs reviewer attention (from anyone!) to move forward
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants