Add documentation, examples, and tests for public functions#15
Open
welps wants to merge 1 commit into
Open
Conversation
Author
|
@SimonSapin Hi, is this still being maintained? If so, can you please take a look at my PR to add documentation? Additionally there's #14 which updates the casefolding mappings. Thanks. |
Author
|
@SimonSapin @Manishearth Hi, can either of you take a look? |
Member
|
I don't maintain this crate. I can look at this eventually, but I'm a bit busy right now. |
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
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.
Addresses #11
Hi, I've added documentation, examples, and tests to each function. I've used the text from Section 3.13 where relevant to help clarify the different matching usage and their behavioral differences.
See below for examples of how the generated rust documentation looks: