[Merged by Bors] - Document remaining members of bevy_utils #6897
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
james7132
added
C-Docs
tim-blackbird
approved these changes
Dec 9, 2022
Co-authored-by: ira <JustTheCoolDude@gmail.com>
Carter0
reviewed
Dec 10, 2022
Carter0
reviewed
Dec 10, 2022
| /// This method tests for `self` and `other` values to be equal. | ||
| /// | ||
| /// Implementors should avoid returning `true` when the underlying types are | ||
| /// not the same. |
There was a problem hiding this comment.
Nit:
I think maybe you can be a little stronger with the language here. I don't see a reason at all for someone to return true if the underlying types are different. Though maybe I am missing a use case for something like that?
Maybe just replace avoid with not?
There was a problem hiding this comment.
That's an interesting one. Should 0u64.dyn_eq(0u32) return true? IMO it probably should.
There was a problem hiding this comment.
Should this trait be manually implementable at all? Adding the bound DynEq: Eq should make any impls other than the blanket impl impossible.
There was a problem hiding this comment.
I'd rather not introduce a breaking change in a docs PR, and even then it may not be desirable force it to only work with same type to same type equality.
Carter0
reviewed
Dec 10, 2022
Co-authored-by: Carter Weinberg <weinbergcarter@gmail.com>
james7132
added
the
S-Ready-For-Final-Review
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Dec 11, 2022
# Objective Partially address #3492. ## Solution Document the remaining undocumented members of `bevy_utils` and set `warn(missing_docs)` on the crate level. Also enabled `clippy::undocumented_unsafe_blocks` as a warning on the crate to keep it in sync with `bevy_ecs`'s warnings.
|
Pull request successfully merged into main. Build succeeded:
|
bors
bot
changed the title
alradish
pushed a commit
to alradish/bevy
that referenced
this pull request
Jan 22, 2023
# Objective Partially address bevyengine#3492. ## Solution Document the remaining undocumented members of `bevy_utils` and set `warn(missing_docs)` on the crate level. Also enabled `clippy::undocumented_unsafe_blocks` as a warning on the crate to keep it in sync with `bevy_ecs`'s warnings.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective Partially address bevyengine#3492. ## Solution Document the remaining undocumented members of `bevy_utils` and set `warn(missing_docs)` on the crate level. Also enabled `clippy::undocumented_unsafe_blocks` as a warning on the crate to keep it in sync with `bevy_ecs`'s warnings.
45 tasks
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
Partially address #3492.
Solution
Document the remaining undocumented members of
bevy_utilsand setwarn(missing_docs)on the crate level. Also enabledclippy::undocumented_unsafe_blocksas a warning on the crate to keep it in sync withbevy_ecs's warnings.