diff options
| author | Mukund Lakshman <yaymukund@gmail.com> | 2021-10-01 06:17:15 -0400 |
|---|---|---|
| committer | Mukund Lakshman <yaymukund@gmail.com> | 2021-10-04 05:01:04 -0400 |
| commit | a8a40ea9a4947a7b46421564517ee2aa4e3711f0 (patch) | |
| tree | b636e1f880c0f4aa70866dbc99e60621b2e80664 /src/librustdoc/html/markdown | |
| parent | e737694a4d66b01308b73d4559a35b43e414faf9 (diff) | |
| download | rust-a8a40ea9a4947a7b46421564517ee2aa4e3711f0.tar.gz rust-a8a40ea9a4947a7b46421564517ee2aa4e3711f0.zip | |
librustdoc: Use correct heading levels.
- Avoid multiple <h1>s on a page. - The <h#> tags should follow a semantic hierarchy. - Cap at h6 (no h7)
Diffstat (limited to 'src/librustdoc/html/markdown')
| -rw-r--r-- | src/librustdoc/html/markdown/tests.rs | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/librustdoc/html/markdown/tests.rs b/src/librustdoc/html/markdown/tests.rs index 1e4cf3381f6..c6af7e5847c 100644 --- a/src/librustdoc/html/markdown/tests.rs +++ b/src/librustdoc/html/markdown/tests.rs @@ -147,33 +147,33 @@ fn test_lang_string_tokenizer() { fn test_header() { fn t(input: &str, expect: &str) { let mut map = IdMap::new(); - let output = - Markdown(input, &[], &mut map, ErrorCodes::Yes, DEFAULT_EDITION, &None).into_string(); + let output = Markdown(input, &[], &mut map, ErrorCodes::Yes, DEFAULT_EDITION, &None, 0) + .into_string(); assert_eq!(output, expect, "original: {}", input); } t( "# Foo bar", - "<h1 id=\"foo-bar\" class=\"section-header\"><a href=\"#foo-bar\">Foo bar</a></h1>", + "<h2 id=\"foo-bar\" class=\"section-header\"><a href=\"#foo-bar\">Foo bar</a></h2>", ); t( "## Foo-bar_baz qux", - "<h2 id=\"foo-bar_baz-qux\" class=\"section-header\">\ - <a href=\"#foo-bar_baz-qux\">Foo-bar_baz qux</a></h2>", + "<h3 id=\"foo-bar_baz-qux\" class=\"section-header\">\ + <a href=\"#foo-bar_baz-qux\">Foo-bar_baz qux</a></h3>", ); t( "### **Foo** *bar* baz!?!& -_qux_-%", - "<h3 id=\"foo-bar-baz--qux-\" class=\"section-header\">\ + "<h4 id=\"foo-bar-baz--qux-\" class=\"section-header\">\ <a href=\"#foo-bar-baz--qux-\"><strong>Foo</strong> \ <em>bar</em> baz!?!& -<em>qux</em>-%</a>\ - </h3>", + </h4>", ); t( "#### **Foo?** & \\*bar?!* _`baz`_ ❤ #qux", - "<h4 id=\"foo--bar--baz--qux\" class=\"section-header\">\ + "<h5 id=\"foo--bar--baz--qux\" class=\"section-header\">\ <a href=\"#foo--bar--baz--qux\"><strong>Foo?</strong> & *bar?!* \ <em><code>baz</code></em> ❤ #qux</a>\ - </h4>", + </h5>", ); } @@ -182,39 +182,39 @@ fn test_header_ids_multiple_blocks() { let mut map = IdMap::new(); fn t(map: &mut IdMap, input: &str, expect: &str) { let output = - Markdown(input, &[], map, ErrorCodes::Yes, DEFAULT_EDITION, &None).into_string(); + Markdown(input, &[], map, ErrorCodes::Yes, DEFAULT_EDITION, &None, 0).into_string(); assert_eq!(output, expect, "original: {}", input); } t( &mut map, "# Example", - "<h1 id=\"example\" class=\"section-header\"><a href=\"#example\">Example</a></h1>", + "<h2 id=\"example\" class=\"section-header\"><a href=\"#example\">Example</a></h2>", ); t( &mut map, "# Panics", - "<h1 id=\"panics\" class=\"section-header\"><a href=\"#panics\">Panics</a></h1>", + "<h2 id=\"panics\" class=\"section-header\"><a href=\"#panics\">Panics</a></h2>", ); t( &mut map, "# Example", - "<h1 id=\"example-1\" class=\"section-header\"><a href=\"#example-1\">Example</a></h1>", + "<h2 id=\"example-1\" class=\"section-header\"><a href=\"#example-1\">Example</a></h2>", ); t( &mut map, "# Main", - "<h1 id=\"main-1\" class=\"section-header\"><a href=\"#main-1\">Main</a></h1>", + "<h2 id=\"main-1\" class=\"section-header\"><a href=\"#main-1\">Main</a></h2>", ); t( &mut map, "# Example", - "<h1 id=\"example-2\" class=\"section-header\"><a href=\"#example-2\">Example</a></h1>", + "<h2 id=\"example-2\" class=\"section-header\"><a href=\"#example-2\">Example</a></h2>", ); t( &mut map, "# Panics", - "<h1 id=\"panics-1\" class=\"section-header\"><a href=\"#panics-1\">Panics</a></h1>", + "<h2 id=\"panics-1\" class=\"section-header\"><a href=\"#panics-1\">Panics</a></h2>", ); } |
