[Merged by Bors] - remove a doc(hidden) on read only version of derive(WorldQuery)
#6877
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
Dec 7, 2022
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
also updated the doc comments on the struct since they referred to it as "internal" which would be rather confusing if intended for actual usage lol. before this PR: long term it would be nice to improve |
mockersf
approved these changes
Dec 7, 2022
tim-blackbird
approved these changes
Dec 7, 2022
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Dec 7, 2022
…6877) having `doc(hidden)` on the read only version of a generated mutable world query leads to docs on the readonly item having a dead link. It also makes it annoying to have nice docs for libraries attempting to expose derived `WorldQuery` structs as re-exporting the read only item does not cause it to appear in docs even though it would be intended for users to know about the read only world query and use it.
|
Pull request successfully merged into main. Build succeeded:
|
bors
bot
changed the title
doc(hidden) on read only version of derive(WorldQuery)doc(hidden) on read only version of derive(WorldQuery)
alradish
pushed a commit
to alradish/bevy
that referenced
this pull request
Jan 22, 2023
…evyengine#6877) having `doc(hidden)` on the read only version of a generated mutable world query leads to docs on the readonly item having a dead link. It also makes it annoying to have nice docs for libraries attempting to expose derived `WorldQuery` structs as re-exporting the read only item does not cause it to appear in docs even though it would be intended for users to know about the read only world query and use it.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…evyengine#6877) having `doc(hidden)` on the read only version of a generated mutable world query leads to docs on the readonly item having a dead link. It also makes it annoying to have nice docs for libraries attempting to expose derived `WorldQuery` structs as re-exporting the read only item does not cause it to appear in docs even though it would be intended for users to know about the read only world query and use it.
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.
having
doc(hidden)on the read only version of a generated mutable world query leads to docs on the readonly item having a dead link. It also makes it annoying to have nice docs for libraries attempting to expose derivedWorldQuerystructs as re-exporting the read only item does not cause it to appear in docs even though it would be intended for users to know about the read only world query and use it.