Add better docs on the relationship between Locale and DataLocale #7382
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
components/locale_core/src/data.rs
Outdated
Comment on lines
36
to
38
| /// // When directly converted, -u-rg is implicitly dropped | ||
| /// let data_locale = DataLocale::from(&locale); | ||
| /// assert_writeable_eq!(data_locale, "en-US"); |
Member
There was a problem hiding this comment.
suggestion: frame this as a feature, not a bug. if move this below the preference examples, then you can say "Direct conversion behaves like language-priority fallback", as that was already explained
| /// You can create a [`DataLocale`] from a borrowed [`Locale`], which is more | ||
| /// efficient than cloning the [`Locale`], but less efficient than converting an owned | ||
| /// [`Locale`]: | ||
| /// In general, you should not need to construct one of these directly. If you do, |
Member
There was a problem hiding this comment.
If you ever see this type, it's very likely that you need to construct one (because you're inside ICU4X).
Member
Author
There was a problem hiding this comment.
it's in the public API of LocaleFallbacker
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.
Extracted from #7346
We want these docs to be good especially with #7348
3.0 follow-up: #7381