Trait documentation clarifications#33815

Merged

bors merged 21 commits intorust-lang:masterfrom

carols10cents:trait-documentation-clarifications

May 27, 2016

Commits on May 23, 2016

Add explanations about what derived trait implementations do
carols10cents
committed
`derive` explanation for PartialOrd should match that for Ord
carols10cents
committed
Make `Derivable` header be an h2 instead of an h1
carols10cents
committed
Reorder `Copy` doc sections
carols10cents
committed
Add an explicit "How can I implement `PartialEq`"? doc section
carols10cents
committed
Add an explicit "How can I implement `Eq`" doc section
carols10cents
committed
Add more detail to `Clone`'s documentation
carols10cents
committed
Add more information about implementing `Hash`
carols10cents
committed
Add an explicit "How can I implement `Ord`" doc section
carols10cents
committed
Add an explicit "How can I implement `PartialOrd`" doc section
carols10cents
committed
Make the Default docs more like the other traits
carols10cents
committed
Shorten, yet clarify, initial summary sentences
carols10cents
committed
Emphasize semantic differences of Copy/Clone rather than impl
carols10cents
committed
"more than 32" => "more than 32 elements"
carols10cents
committed
"non equal" => "not equal"; consistent with the surrounding text
carols10cents
committed
Add some newlines in some code examples
carols10cents
committed
Use `()` when referring to functions
carols10cents
committed
Prefer `ClassName` over `Self` in example trait implementations
carols10cents
committed
Move all `Default` docs from module to trait
carols10cents
committed
Complete `PartialOrd`'s example so it passes make check-docs
carols10cents
committed
"the trait `Hash`" => "the `Hash` trait"
carols10cents
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Trait documentation clarifications#33815

Trait documentation clarifications#33815
bors merged 21 commits intorust-lang:masterfrom
carols10cents:trait-documentation-clarifications

Commits on May 23, 2016

Add explanations about what derived trait implementations do

`derive` explanation for PartialOrd should match that for Ord

Make `Derivable` header be an h2 instead of an h1

Reorder `Copy` doc sections

Add an explicit "How can I implement `PartialEq`"? doc section

Add an explicit "How can I implement `Eq`" doc section

Add more detail to `Clone`'s documentation

Add more information about implementing `Hash`

Add an explicit "How can I implement `Ord`" doc section

Add an explicit "How can I implement `PartialOrd`" doc section

Make the Default docs more like the other traits

Shorten, yet clarify, initial summary sentences

Emphasize semantic differences of Copy/Clone rather than impl

"more than 32" => "more than 32 elements"

"non equal" => "not equal"; consistent with the surrounding text

Add some newlines in some code examples

Use `()` when referring to functions

Prefer `ClassName` over `Self` in example trait implementations

Move all `Default` docs from module to trait

Complete `PartialOrd`'s example so it passes make check-docs

"the trait `Hash`" => "the `Hash` trait"

Trait documentation clarifications#33815bors merged 21 commits intorust-lang:masterrust-lang/rust:masterfrom carols10cents:trait-documentation-clarificationsCopy head branch name to clipboard

Commits

Commits on May 23, 2016

Trait documentation clarifications#33815
bors merged 21 commits intorust-lang:masterfrom
carols10cents:trait-documentation-clarifications