Skip to content

Conversation

@HarrisonMc555
Copy link
Contributor

@HarrisonMc555 HarrisonMc555 commented May 25, 2020

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.

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.
@Manishearth Manishearth merged commit ec65d22 into unicode-rs:master May 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants