We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent c21fd9a commit cbf97c3Copy full SHA for cbf97c3
src/doc/style/style/comments.md
@@ -85,3 +85,20 @@ Use inner doc comments _only_ to document crates and file-level modules:
85
//!
86
//! The core library is a something something...
87
```
88
+
89
+### Explain context.
90
91
+Rust doesn't have special constructors, only functions that return new
92
+instances. These aren't visible in the automatically generated documentation
93
+for a type, so you should specifically link to them:
94
95
+``` rust
96
+/// An iterator that yields `None` forever after the underlying iterator
97
+/// yields `None` once.
98
+///
99
+/// These can be created through
100
+/// [`iter.fuse()`](trait.Iterator.html#method.fuse).
101
+pub struct Fuse<I> {
102
+ // ...
103
+}
104
+```
0 commit comments