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.

Sign up for GitHub

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

Jump to bottom

Fill out some missing docs for bevy_assets #17829

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fill out some missing docs for bevy_assets #17829

wants to merge 2 commits into from

Conversation

alice-i-cecile
Copy link
Member

Objective

bevy_assets has long been unapproachable for contributors and users. More and better documentation would help that.

We're gradually moving towards globally denying missing docs (#3492)!
However, writing all of the hundreds of missing doc strings in a single go will be miserable to review.

Solution

Remove the allow for missing docs temporarily, and then pick some easy missing doc warnings largely at random to tackle.

Stop when the change set is starting to feel intimidating.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Assets Load files from disk to use for things like images, models, and sounds S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Feb 12, 2025
@alice-i-cecile alice-i-cecile added X-Uncontroversial This work is generally agreed upon D-Straightforward Simple bug fixes and API improvements, docs, test and examples labels Feb 12, 2025
andriyDev
andriyDev approved these changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@andriyDev andriyDev left a comment

Choose a reason for hiding this comment

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

Looks good!

@alice-i-cecile
Copy link
Member Author

@Carter0, want to take a look at this PR too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andriyDev andriyDev andriyDev approved these changes

Assignees
No one assigned
Labels
A-Assets Load files from disk to use for things like images, models, and sounds C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review Needs reviewer attention (from anyone!) to move forward X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alice-i-cecile @andriyDev