Improve clarity of existing bevy_assets documentation #17830
+14
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alice-i-cecile
added
C-Docs
andriyDev
approved these changes
Feb 13, 2025
| @@ -5,6 +5,8 @@ use bevy_reflect::TypePath; | |||
|
|
|||
| /// A "loaded folder" containing handles for all assets stored in a given [`AssetPath`]. | |||
| /// | |||
| /// This is produced by [`AssetServer::load_folder`](crate::prelude::AssetServer::load_folder). | |||
There was a problem hiding this comment.
For my own learning, do these links work? I thought you either need it to guess it automatically or there's a "symbol" section in another paragraph.
There was a problem hiding this comment.
These inline links are the third way :) These vs new-line links are just a matter of style.
alice-i-cecile
added
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
While surveying the state of documentation for bevy_assets, I noticed a few minor issues.
Solution
Revise the docs to focus on clear explanations of core ideas and cross-linking related objects.