rust/src/libcore
Guillaume Gomez 967c3880d8 Rollup merge of #33815 - carols10cents:trait-documentation-clarifications, r=steveklabnik
Trait documentation clarifications

Hi! I've felt a bit of friction lately in figuring out how to write custom implementations of the `derive`able traits, so I decided to add to the docs :)

The docs for `Copy` are already excellent-- clear, useful sections that I only reordered a bit-- they're now:

* General explanation
* When can my type be `Copy`?
* When can my type _not_ be `Copy`?
* When should my type be `Copy`?
* Derivable
* How can I implement `Copy`?

I didn't add all these sections for all the traits, but I did make sure all the derivable traits had a consistent "Derivable" section that explained what the derived implementation does and a "How can I implement" section that has an example.

Please check me for correctness-- I tried to do research to make sure I was saying accurate things but I'm still learning! ❤️ I'd also love suggestions on information to add that is still missing-- I think these traits are important and deserve to have awesome docs!
2016-05-27 10:50:03 +02:00
..
fmt Add explanations about what derived trait implementations do 2016-05-23 10:03:44 -04:00
hash "the trait Hash" => "the Hash trait" 2016-05-23 14:39:41 -04:00
iter std: Stabilize APIs for the 1.10 release 2016-05-24 09:00:39 -07:00
num Fix asm! blocks 2016-05-16 15:41:45 +02:00
prelude Add missing annotations and some tests 2015-11-18 01:24:21 +03:00
str Auto merge of #32909 - sanxiyn:unused-trait-import-2, r=alexcrichton 2016-04-16 18:31:11 -07:00
sync Auto merge of #33699 - alexcrichton:stabilize-1.10, r=aturon 2016-05-25 20:36:09 -07:00
any.rs doc: Fix a bunch of broken links 2016-03-08 13:44:14 -08:00
array.rs Fix broken links for core primitives 2016-03-01 20:44:48 +08:00
borrow.rs Move the Borrow and BorrowMut traits to libcore. 2015-08-22 13:58:39 +02:00
build.rs rustbuild: Tighten dependencies of build scripts 2016-05-10 23:41:19 -07:00
Cargo.toml rustbuild: Add support for crate tests + doctests 2016-05-12 08:52:20 -07:00
cell.rs Auto merge of #33306 - vadixidav:master, r=alexcrichton 2016-05-12 00:18:15 -07:00
char.rs Auto merge of #33699 - alexcrichton:stabilize-1.10, r=aturon 2016-05-25 20:36:09 -07:00
clone.rs Prefer ClassName over Self in example trait implementations 2016-05-23 13:14:15 -04:00
cmp.rs Complete PartialOrd's example so it passes make check-docs 2016-05-23 14:39:41 -04:00
convert.rs Implement RFC 1542 2016-05-07 08:52:41 -07:00
default.rs Move all Default docs from module to trait 2016-05-23 13:47:28 -04:00
intrinsics.rs core::intrinsics: fix typo noted during review. 2016-05-16 17:10:44 +02:00
lib.rs Fix fast path of float parsing on x87 2016-05-13 15:18:31 +02:00
macros.rs Remove unnecessary parens in macro 2016-05-18 22:24:33 +09:00
marker.rs Reorder Copy doc sections 2016-05-23 10:03:44 -04:00
mem.rs Rollup merge of #33357 - pcwalton:inline-mem-forget, r=brson 2016-05-03 19:54:56 +05:30
nonzero.rs Register new snapshots 2015-12-21 09:26:21 -08:00
ops.rs Add a note about overflowing in the RangeFrom iterator 2016-04-13 20:09:15 +02:00
option.rs Remove unused trait imports 2016-04-12 22:58:55 +09:00
panicking.rs Mark all extern functions as nounwind 2015-09-14 11:36:09 +02:00
ptr.rs Improve as_mut ptr method example 2016-04-17 18:50:49 +02:00
raw.rs std: Stabilize APIs for the 1.9 release 2016-04-11 08:57:53 -07:00
result.rs Rollup merge of #32854 - GuillaumeGomez:result_doc, r=steveklabnik 2016-04-11 10:31:28 -04:00
slice.rs Auto merge of #33699 - alexcrichton:stabilize-1.10, r=aturon 2016-05-25 20:36:09 -07:00
tuple.rs Properly document tuples 2016-02-09 16:00:50 -05:00