Don't show .to_bits in Display impl for Entity
#14011
Merged
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
D-Trivial
kristoff3r
approved these changes
Jun 25, 2024
Co-authored-by: Kristoffer Søholm <k.soeholm@gmail.com>
|
@eidloi could I get your review here? |
viridia
approved these changes
Jun 25, 2024
|
Exactly what I needed thanks! |
eidloi
approved these changes
Jun 25, 2024
|
Thanks y'all! |
mockersf
pushed a commit
that referenced
this pull request
Jun 25, 2024
accurate for debugging. To ensure that its can still be readily logged in error messages and inspectors, this PR added a more concise and human-friendly `Display` impl. However, users found this form too verbose: the `to_bits` information was unhelpful and too long. Fixes #13980. - Don't include `Entity::to_bits` in the `Display` implementation for `Entity`. This information can readily be accessed and logged for users who need it. - Also clean up the implementation of `Display` for `DebugName`, introduced in #13760, to simply use the new `Display` impl (since this was the desired format there). I've updated an existing test to verify the output of `Entity::display`. --------- Co-authored-by: Kristoffer Søholm <k.soeholm@gmail.com>
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
#12469 changed the
Debugimpl forEntity, making sure it's actually accurate for debugging. To ensure that its can still be readily logged in error messages and inspectors, this PR added a more concise and human-friendlyDisplayimpl.However, users found this form too verbose: the
to_bitsinformation was unhelpful and too long. Fixes #13980.Solution
Entity::to_bitsin theDisplayimplementation forEntity. This information can readily be accessed and logged for users who need it.DisplayforDebugName, introduced in Add Display implementation to DebugName. #13760, to simply use the newDisplayimpl (since this was the desired format there).Testing
I've updated an existing test to verify the output of
Entity::display.