Clarify that Duplicate Option Name is a data model error #577
Conversation
This file contains hidden or 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
aphillips
reviewed
Jan 2, 2024
spec/formatting.md
Outdated
Comment on lines
217
to
218
| - If the _option_'s _identifier_ already exists in the resolved mapping of _options_, | ||
| emit a Duplicate Option Name error. |
There was a problem hiding this comment.
Why remove this? An implementation might detect this during parsing (which, it sounds like, you're doing when populating the data model). But it might not (if it naively parses the message and doesn't evaluate options until formatting time). Does this directive do any harm?
There was a problem hiding this comment.
Because we don't do that for any of the data model errors, and keeping this here would create a requirement for throwing data model errors during formatting, rather than before.
We should probably move the syntax & data model error definitions out of formatting.md into their own doc, and make it clearer that a message must be validated against all of them before formatting.
Co-authored-by: Addison Phillips <addisonI18N@gmail.com>
eemeli
commented
Jan 2, 2024
Good callout Co-authored-by: Eemeli Aro <eemeli@gmail.com>
aphillips
approved these changes
Jan 15, 2024
This was referenced Mar 7, 2024
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.
I noticed during implementation that even though we define Duplicate Option Name as a data model error, we handle it as a formatting error. This should be clarified.