]> git.lizzy.rs Git - rust.git/commitdiff
Fix rustoc item summaries that are headers
authorChristian Duerr <contact@christianduerr.com>
Wed, 29 Nov 2017 23:28:59 +0000 (00:28 +0100)
committerChristian Duerr <contact@christianduerr.com>
Wed, 29 Nov 2017 23:28:59 +0000 (00:28 +0100)
Rustoc item summaries that are headers were not displayed at all because
they started with whitespace.

This PR fixes this and now removes the whitespace and then displays the
block.

src/librustdoc/html/render.rs
src/test/rustdoc/issue-46377.rs [new file with mode: 0644]

index cf557b1c661d6e9d6c35aa9e61763e6e8ae751d8..41918dfd3c31599051591390c436bf3338c2b236 100644 (file)
@@ -1819,7 +1819,9 @@ fn full_path(cx: &Context, item: &clean::Item) -> String {
 
 fn shorter<'a>(s: Option<&'a str>) -> String {
     match s {
-        Some(s) => s.lines().take_while(|line|{
+        Some(s) => s.lines()
+            .skip_while(|s| s.chars().all(|c| c.is_whitespace()))
+            .take_while(|line|{
             (*line).chars().any(|chr|{
                 !chr.is_whitespace()
             })
diff --git a/src/test/rustdoc/issue-46377.rs b/src/test/rustdoc/issue-46377.rs
new file mode 100644 (file)
index 0000000..db8c766
--- /dev/null
@@ -0,0 +1,13 @@
+// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// @has 'issue_46377/index.html' '//*[@class="docblock-short"]' 'Check out this struct!'
+/// # Check out this struct!
+pub struct SomeStruct;