Added brief modules documentation #21
Merged
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
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.
Types of changes
Related: #12
Description
This pull request includes documentation improvements across multiple modules to enhance clarity and consistency. The changes primarily involve adding module-level documentation and updating existing comments to use a more consistent format.
Documentation improvements:
src/lib.rs: Updated the module list comments to use a consistent format with backticks for module names and added periods at the end of each description.src/bcp47.rs: Added a module-level comment to describe the purpose of thebcp47module for matching locales in the BCP 47 format.src/posix.rs: Added a module-level comment to describe the purpose of theposixmodule for matching locales in the POSIX format.