diff options
| author | Tshepang Mbambo <tshepang@gmail.com> | 2022-07-31 01:01:58 +0200 |
|---|---|---|
| committer | Tshepang Mbambo <tshepang@gmail.com> | 2022-07-31 07:46:57 +0200 |
| commit | 55370dae9eb0ebc8a44f29c57450b841629f99d3 (patch) | |
| tree | 7cec6929b976285814eab94e334f6d1cadd4fc3e /src/doc/rustc-dev-guide | |
| parent | 6339e3368db7d54380255ec2e5ce4ab777d59324 (diff) | |
| download | rust-55370dae9eb0ebc8a44f29c57450b841629f99d3.tar.gz rust-55370dae9eb0ebc8a44f29c57450b841629f99d3.zip | |
try address review comments
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/building/compiler-documenting.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/compiler-documenting.md b/src/doc/rustc-dev-guide/src/building/compiler-documenting.md index 7c52b4b819b..9ed5c262b84 100644 --- a/src/doc/rustc-dev-guide/src/building/compiler-documenting.md +++ b/src/doc/rustc-dev-guide/src/building/compiler-documenting.md @@ -1,13 +1,13 @@ # Building documentation This chapter describes how to build documentation of toolchain components, -either in whole or individually. +like the standard library (std) or the compiler (rustc). - Document everything This uses `rustdoc` from the beta toolchain, so will produce (slightly) different output to stage 1 rustdoc, - as `rustdoc` is under active development: + as rustdoc is under active development: ```bash ./x.py doc @@ -20,8 +20,8 @@ either in whole or individually. ``` First, - the compiler and rustdoc get built to make sure everything is okay, - and then it documents the files. + the compiler gets built to make sure rustdoc compiles, + then that newly-built rustdoc is used to document the components. - Much like running individual tests or building specific components, you can build just the documentation you want: |