Improved documentation for get_locale and get_locales
#37
Conversation
This file contains 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
pasabanov
changed the title
get_locale and get_localesget_locale and get_locales
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.
Related: #22.
Documentation changes in
src/lib.rs:get_locale: 1. The description of the returned locale was changed from
activetomost preferredto better align with the intended meaning and implementation.2. Rust's documentation conventions were used to highlight data types:
Some(String)andNone.3. A line break was added for improved readability.
4.
BCP-47was replaced with the more accurateBCP 47.get_locales: 1. The return type specified in the documentation was changed from
VectoIterator.2. A line break was added for improved readability.
3.
BCP-47was replaced with the more accurateBCP 47.