Link to creating methods in struct documentation #81
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
The Rust standard library has a nice practice for documentation for public structs. Documentation for these structs include links to the method that creates them. This is very useful for beginners who may stumble upon the documentation for the struct when they would really like documentation for the method. Add documentation for all of the structs that are created by methods on the `UnicodeSegmentation` trait with links back to the creating methods.
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.
The Rust standard library has a nice practice for documentation for public structs. Documentation for these structs include links to the method that creates them. This is very useful for beginners who may stumble upon the documentation for the struct when they would really like documentation for the method.
Add documentation for all of the structs that are created by methods on the
UnicodeSegmentationtrait with links back to the creating methods.