From 180b859b265679cce46dac331b4b4bac47a0286d Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume1.gomez@gmail.com>
Date: Tue, 14 May 2019 14:28:32 +0200
Subject: [PATCH] Add comment to explain what is the top parameter

---
 src/librustdoc/html/render.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
index a2e843828f7a3..082dd7147528b 100644
--- 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();