Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistent formatting of entities in error messages #16104

Closed
SpecificProtagonist opened this issue Oct 25, 2024 · 0 comments · Fixed by #16112
Closed

Consistent formatting of entities in error messages #16104

SpecificProtagonist opened this issue Oct 25, 2024 · 0 comments · Fixed by #16112
Assignees
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Usability A targeted quality-of-life change that makes Bevy easier to use D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!

Comments

@SpecificProtagonist
Copy link
Contributor

SpecificProtagonist commented Oct 25, 2024

How can Bevy's documentation be improved?

Some error messages (such as in EntityCommands::insert) Debug-format entities, while others (such as in InsertReflect) use Display-formatting. This should be made more consistent.

Display format is {id}v{generation} while Debug format is {id}v{generation}#{raw bits}. The raw bits contain the same data, but are useful for comparing with serialized entities.

@SpecificProtagonist SpecificProtagonist added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Oct 25, 2024
@BenjaminBrienen BenjaminBrienen added C-Usability A targeted quality-of-life change that makes Bevy easier to use S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it! A-Diagnostics Logging, crash handling, error reporting and performance analysis D-Straightforward Simple bug fixes and API improvements, docs, test and examples and removed C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Oct 26, 2024
@BenjaminBrienen BenjaminBrienen self-assigned this Oct 26, 2024
github-merge-queue bot pushed a commit that referenced this issue Dec 27, 2024
# Objective

Fixes #16104

## Solution

I removed all instances of `:?` and put them back one by one where it
caused an error.

I removed some bevy_utils helper functions that were only used in 2
places and don't add value. See: #11478

## Testing

CI should catch the mistakes

## Migration Guide

`bevy::utils::{dbg,info,warn,error}` were removed. Use
`bevy::utils::tracing::{debug,info,warn,error}` instead.

---------

Co-authored-by: SpecificProtagonist <vincentjunge@posteo.net>
ecoskey pushed a commit to ecoskey/bevy that referenced this issue Jan 6, 2025
# Objective

Fixes bevyengine#16104

## Solution

I removed all instances of `:?` and put them back one by one where it
caused an error.

I removed some bevy_utils helper functions that were only used in 2
places and don't add value. See: bevyengine#11478

## Testing

CI should catch the mistakes

## Migration Guide

`bevy::utils::{dbg,info,warn,error}` were removed. Use
`bevy::utils::tracing::{debug,info,warn,error}` instead.

---------

Co-authored-by: SpecificProtagonist <vincentjunge@posteo.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Diagnostics Logging, crash handling, error reporting and performance analysis C-Usability A targeted quality-of-life change that makes Bevy easier to use D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants