Include additional documentation for scrape-examples changes

2 files changed, 8 insertions, 2 deletions

diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index ec941c3a938..0432d445d53 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -1817,9 +1817,12 @@ in storage.js
 
 /* Should have min-width: (N + 1)px where N is the mobile breakpoint above. */
 @media (min-width: 701px) {
+	/* Places file-link for a scraped example on top of the example to save space.
+	   We only do this on large screens so the file-link doesn't overlap too much
+		 with the example's content. */
 	.scraped-example-title {
 		position: absolute;
-		z-index: 1000;
+		z-index: 10;
 		background: var(--main-background-color);
 		bottom: 8px;
 		right: 5px;
@@ -1915,6 +1918,7 @@ in storage.js
 }
 
 .scraped-example {
+	/* So .scraped-example-title can be positioned absolutely */
 	position: relative;
 }
 
diff --git a/src/librustdoc/html/static/js/scrape-examples.js b/src/librustdoc/html/static/js/scrape-examples.js
index 82b71ad0fca..d179909ac7f 100644
--- a/src/librustdoc/html/static/js/scrape-examples.js
+++ b/src/librustdoc/html/static/js/scrape-examples.js
@@ -3,7 +3,9 @@
 "use strict";
 
 (function() {
-    // Number of lines shown when code viewer is not expanded
+    // Number of lines shown when code viewer is not expanded.
+    // DEFAULT is the first example shown by default, while HIDDEN is
+    // the examples hidden beneath the "More examples" toggle.
     const DEFAULT_MAX_LINES = 5;
     const HIDDEN_MAX_LINES = 10;