chore: Enhance documentation for currency data structures #7424
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
younies
force-pushed
the
fix-doc-displyname-currency
branch
from
9e8dce4 to
0d17b9a
Compare
Comment on lines
+17
to
+19
| /// Provides currency compact data for short currency formatting. | ||
| /// | ||
| /// For example, "1000 US dollars" becomes "1k USD" in en-US. |
Member
There was a problem hiding this comment.
this gives an example of the operation that this data is used for, but doesn't really explain the data. what are we storing?
Suggested change
| /// Provides currency compact data for short currency formatting. | |
| /// | |
| /// For example, "1000 US dollars" becomes "1k USD" in en-US. | |
| /// Compact plural patterns for use in currency formatting | |
| /// | |
| /// This data is not currency-specific. |
|
|
||
| icu_provider::data_marker!( | ||
| /// Essential currency data needed for currency formatting. For example, currency patterns. | ||
| /// Provides essential currency data needed for currency formatting. For example, currency patterns. |
Member
There was a problem hiding this comment.
issue: compact currency patterns are currency patterns, but they are in a different data marker. be more specific
also add if this is keyed by currency or only by locale
|
|
||
| icu_provider::data_marker!( | ||
| /// Extended currency data needed for currency formatting. For example, currency display names. | ||
| /// Provides extended currency data needed for long / full name currency formatting. |
Member
There was a problem hiding this comment.
"extended" doesn't explain anything, it's a classification that you came up with.
Suggested change
| /// Provides extended currency data needed for long / full name currency formatting. | |
| /// Provides plural display names for currencies. | |
| /// | |
| /// This data is keyed by both locale and currency, with a currency code marker attribute. |
|
|
||
| icu_provider::data_marker!( | ||
| /// `CurrencyPatternsDataV1` | ||
| /// Provides currency patterns information for currency formatting. |
Member
There was a problem hiding this comment.
Suggested change
| /// Provides currency patterns information for currency formatting. | |
| /// Provides plural currency glue patterns to merge values and display names. |
…yname.rs Co-authored-by: Robert Bastian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.