Improve doc formatting. #9840
Merged
Improve doc formatting. #9840
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
approved these changes
Sep 18, 2023
alice-i-cecile
added
C-Docs
mockersf
reviewed
Sep 18, 2023
| /// This is faster than doing equivalent operations one-by-one. | ||
| /// Returns [Ok] if all entities were successfully inserted into or spawned. Otherwise it returns an [Err] | ||
| /// Returns `Ok` if all entities were successfully inserted into or spawned. Otherwise it returns an `Err` |
There was a problem hiding this comment.
Suggested change
| /// Returns `Ok` if all entities were successfully inserted into or spawned. Otherwise it returns an `Err` | |
| /// Returns `Ok()` if all entities were successfully inserted into or spawned. Otherwise it returns an `Err` |
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
# Objective - Identifiers in docs should be marked up with backticks. ## Solution - Mark up more identifiers in the docs with backticks.
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
Solution