about summary refs log tree commit diff
diff options
context:
space:
mode:
authorQuietMisdreavus <grey@quietmisdreavus.net>2018-02-20 09:26:44 -0600
committerQuietMisdreavus <grey@quietmisdreavus.net>2018-02-20 09:26:44 -0600
commit8d893c1e9e136302a1640035b29e23023f87866e (patch)
treeb083817b5bfd455fa9893b9d1d2654f3590fecc7
parent7aca34b8963fd9ac8681485a44417e537e617245 (diff)
downloadrust-8d893c1e9e136302a1640035b29e23023f87866e.tar.gz
rust-8d893c1e9e136302a1640035b29e23023f87866e.zip
review nits
-rw-r--r--src/librustdoc/README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/librustdoc/README.md b/src/librustdoc/README.md
index 844c54c7aa8..b0a5ae3718d 100644
--- a/src/librustdoc/README.md
+++ b/src/librustdoc/README.md
@@ -28,8 +28,8 @@ that's the high-level overview.
     CSS/JS and landing page are.
 * Most of the HTML printing code is in `html/format.rs` and `html/render.rs`. It's in a bunch of
   `fmt::Display` implementations and supplementary functions.
-* The types that operates on are defined in `clean/mod.rs`, right next to the custom `Clean` trait
-  used to process them out of the rustc HIR.
+* The types that got `Display` impls above are defined in `clean/mod.rs`, right next to the custom
+  `Clean` trait used to process them out of the rustc HIR.
 * The bits specific to using rustdoc as a test harness are in `test.rs`.
 * The Markdown renderer is loaded up in `html/markdown.rs`, including functions for extracting
   doctests from a given block of Markdown.
@@ -68,10 +68,12 @@ and inlining. This is where `#[doc(inline)]`, `#[doc(no_inline)]`, and `#[doc(hi
 processed, as well as the logic for whether a `pub use` should get the full page or a "Reexport"
 line in the module page.
 
-Back in `clean/mod.rs`, the other major thing that happens here is the special collection of doc
-comments (and basic `#[doc=""]` attributes) into a separate field in the `Attributes` struct from
-the other attributes. The primary output of this process is a `clean::Crate` with a tree of `Item`s
-which describe the publicly-documentable items in the target crate.
+The other major thing that happens in `clean/mod.rs` is the collection of doc comments and
+`#[doc=""]` attributes into a separate field of the Attributes struct, present on anything that gets
+hand-written documentation. This makes it easier to collect this documentation later in the process.
+
+The primary output of this process is a clean::Crate with a tree of Items which describe the
+publicly-documentable items in the target crate.
 
 ### Hot potato