@@ -213,7 +213,7 @@ Let's discuss our sample example documentation:
213
213
```
214
214
215
215
You'll notice that you don't need a ` fn main() ` or anything here. ` rustdoc ` will
216
- automatically add a main() wrapper around your code, and in the right place.
216
+ automatically add a ` main() ` wrapper around your code, and in the right place.
217
217
For example:
218
218
219
219
``` rust
@@ -234,7 +234,7 @@ fn main() {
234
234
}
235
235
```
236
236
237
- Here's the full algorithm rustdoc uses to postprocess examples:
237
+ Here's the full algorithm rustdoc uses to preprocess examples:
238
238
239
239
1 . Any leading ` #![foo] ` attributes are left intact as crate attributes.
240
240
2 . Some common ` allow ` attributes are inserted, including
@@ -377,7 +377,7 @@ things, so they don’t show up in the output.
377
377
378
378
### Running documentation tests
379
379
380
- To run the tests, either
380
+ To run the tests, either:
381
381
382
382
``` bash
383
383
$ rustdoc --test path/to/my/crate/root.rs
@@ -502,7 +502,8 @@ This `%` line needs to be the very first line of the file.
502
502
503
503
## ` doc ` attributes
504
504
505
- At a deeper level, documentation comments are sugar for documentation attributes:
505
+ At a deeper level, documentation comments are syntactic sugar for documentation
506
+ attributes:
506
507
507
508
``` rust
508
509
/// this
@@ -533,7 +534,7 @@ extern crate foo;
533
534
pub use foo::bar;
534
535
```
535
536
536
- This will create documentation for bar both inside the documentation for the
537
+ This will create documentation for ` bar ` both inside the documentation for the
537
538
crate ` foo ` , as well as the documentation for your crate. It will use the same
538
539
documentation in both places.
539
540
0 commit comments