Add comment to explain what is the top parameter

rust-lang · May 14, 2019 · 180b859 · 180b859
1 parent f20d586
commit 180b859
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
@@ -3789,6 +3789,14 @@ const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
     "non_exhaustive"
 ];
 
+// The `top` parameter is used when generating the item declaration to ensure it doesn't have a
+// left padding. For example:
+//
+// #[foo] <----- "top" attribute
+// struct Foo {
+//     #[bar] <---- not "top" attribute
+//     bar: usize,
+// }
 fn render_attributes(w: &mut dyn fmt::Write, it: &clean::Item, top: bool) -> fmt::Result {
     let mut attrs = String::new();