Skip to content

Rollup of 10 pull requests #28897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Oct 8, 2015
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
8e420e0
trpl: Clarify closure terminology
chills42 Oct 6, 2015
a78a874
possessive its
chills42 Oct 6, 2015
7895ec2
address review concerns
chills42 Oct 6, 2015
4d40dd3
Restore line endings in a test
steveklabnik Oct 7, 2015
d21b4f5
Use the correct mod name from the example
id4ho Oct 4, 2015
cbf97c3
style guide: suggest manual links to constructors
sourcefrog Oct 7, 2015
4119fc2
Fix "the the" typo and split a run-on sentence
Wallacoloo Sep 20, 2015
03dfe89
Fix a typo
ykomatsu Oct 7, 2015
8fee548
Add new error code
GuillaumeGomez Oct 6, 2015
a94f684
Add error explanation for E0515
GuillaumeGomez Oct 6, 2015
e84461a
Alter formatting for words in Option::cloned doc comment
frewsxcv Oct 7, 2015
2ba0c48
trpl: Use ordered list to release user from counting
JIghtuse Oct 7, 2015
1e0fbbd
trpl: Fix some bad wording in iterators subsection
JIghtuse Oct 7, 2015
18c66b5
Rollup merge of #28836 - jackwilsonv:patch-6, r=steveklabnik
steveklabnik Oct 7, 2015
f688c0e
Rollup merge of #28856 - chills42:master, r=steveklabnik
steveklabnik Oct 7, 2015
4b44296
Rollup merge of #28874 - GuillaumeGomez:error_code, r=Manishearth
steveklabnik Oct 7, 2015
55c2002
Rollup merge of #28876 - steveklabnik:oops, r=Gankro
steveklabnik Oct 7, 2015
5470a1c
Rollup merge of #28878 - sourcefrog:doc-links, r=steveklabnik
steveklabnik Oct 7, 2015
94755b2
Rollup merge of #28880 - Wallacoloo:book-5.14-typo, r=alexcrichton
steveklabnik Oct 7, 2015
4c8a0c0
Rollup merge of #28882 - ykomatsu:trpl, r=steveklabnik
steveklabnik Oct 7, 2015
c66ff93
Rollup merge of #28885 - frewsxcv:patch-25, r=alexcrichton
steveklabnik Oct 7, 2015
fb09639
Rollup merge of #28889 - JIghtuse:str_doc, r=steveklabnik
steveklabnik Oct 7, 2015
0fbf7ea
Rollup merge of #28896 - mkpankov:core-fmt, r=nrc
steveklabnik Oct 7, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
style guide: suggest manual links to constructors
  • Loading branch information
sourcefrog committed Oct 7, 2015
commit cbf97c3e65e288702ccaea7f4a7153a37f7e4ee3
17 changes: 17 additions & 0 deletions src/doc/style/style/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,20 @@ Use inner doc comments _only_ to document crates and file-level modules:
//!
//! The core library is a something something...
```

### Explain context.

Rust doesn't have special constructors, only functions that return new
instances. These aren't visible in the automatically generated documentation
for a type, so you should specifically link to them:

``` rust
/// An iterator that yields `None` forever after the underlying iterator
/// yields `None` once.
///
/// These can be created through
/// [`iter.fuse()`](trait.Iterator.html#method.fuse).
pub struct Fuse<I> {
// ...
}
```