Remove reference to internals in error message for unused values#599
Conversation
Summary of ChangesHello @BugelNiels, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the clarity and abstraction of error messages within the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request simplifies an error message for unused values to avoid exposing library-specific type names. While this is a reasonable goal, the change makes the error message less informative for developers. My feedback includes a suggestion for a more descriptive error message that still avoids mentioning specific types. Additionally, I recommend adding a new test case to cover this scenario, which would validate the error message and prevent future regressions.
| stream << "Value named '" << _current_name_or_index | ||
| << "' not used. Remove the rfl::NoExtraFields processor or add " | ||
| "rfl::ExtraFields to avoid this error message."; | ||
| << "' not used."; |
There was a problem hiding this comment.
This change simplifies the error message, but it also removes helpful context for the developer. While I understand the goal of not exposing library-specific names, the new message might leave developers wondering why an unused field is an error. A good compromise could be to add a hint explaining the reason, which would improve the developer experience without being too specific.
| stream << "Value named '" << _current_name_or_index | |
| << "' not used. Remove the rfl::NoExtraFields processor or add " | |
| "rfl::ExtraFields to avoid this error message."; | |
| << "' not used."; | |
| stream << "Value named '" << _current_name_or_index | |
| << "' not used (extra fields are not allowed)."; |
|
@BugelNiels thanks for the contribution! |
Prevents exposing library internals in the error message when a value is not used (triggered when
rfl::NoExtraFieldsis used).fixes #598