Skip to content

Commit 7b67e2d

Browse files
committed
rustdoc: Write both crates and mods as header level 1
1 parent 7c925cf commit 7b67e2d

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/rustdoc/markdown_pass.rs

+11-11
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ fn write_mod(
6464
moddoc: doc::moddoc
6565
) {
6666
let fullpath = str::connect(moddoc.path + [moddoc.name], "::");
67-
write_header(ctxt, h2, #fmt("Module `%s`", fullpath));
67+
write_header(ctxt, h1, #fmt("Module `%s`", fullpath));
6868
write_mod_contents(ctxt, moddoc);
6969
}
7070

7171
#[test]
7272
fn should_write_full_path_to_mod() {
7373
let markdown = test::render("mod a { mod b { mod c { } } }");
74-
assert str::contains(markdown, "## Module `a::b::c`");
74+
assert str::contains(markdown, "# Module `a::b::c`");
7575
}
7676

7777
fn write_mod_contents(
@@ -118,7 +118,7 @@ fn write_fn(
118118
ctxt: ctxt,
119119
doc: doc::fndoc
120120
) {
121-
write_header(ctxt, h3, #fmt("Function `%s`", doc.name));
121+
write_header(ctxt, h2, #fmt("Function `%s`", doc.name));
122122
write_sig(ctxt, doc.sig);
123123
write_brief(ctxt, doc.brief);
124124
write_desc(ctxt, doc.desc);
@@ -146,7 +146,7 @@ fn code_block_indent(s: str) -> str {
146146
#[test]
147147
fn write_markdown_should_write_function_header() {
148148
let markdown = test::render("fn func() { }");
149-
assert str::contains(markdown, "### Function `func`");
149+
assert str::contains(markdown, "## Function `func`");
150150
}
151151

152152
#[test]
@@ -362,7 +362,7 @@ fn write_const(
362362
ctxt: ctxt,
363363
doc: doc::constdoc
364364
) {
365-
write_header(ctxt, h3, #fmt("Const `%s`", doc.name));
365+
write_header(ctxt, h2, #fmt("Const `%s`", doc.name));
366366
write_sig(ctxt, doc.ty);
367367
write_brief(ctxt, doc.brief);
368368
write_desc(ctxt, doc.desc);
@@ -371,7 +371,7 @@ fn write_const(
371371
#[test]
372372
fn should_write_const_header() {
373373
let markdown = test::render("const a: bool = true;");
374-
assert str::contains(markdown, "### Const `a`\n\n");
374+
assert str::contains(markdown, "## Const `a`\n\n");
375375
}
376376

377377
#[test]
@@ -386,7 +386,7 @@ fn write_enum(
386386
ctxt: ctxt,
387387
doc: doc::enumdoc
388388
) {
389-
write_header(ctxt, h3, #fmt("Enum `%s`", doc.name));
389+
write_header(ctxt, h2, #fmt("Enum `%s`", doc.name));
390390
write_brief(ctxt, doc.brief);
391391
write_desc(ctxt, doc.desc);
392392
write_variants(ctxt, doc.variants);
@@ -395,7 +395,7 @@ fn write_enum(
395395
#[test]
396396
fn should_write_enum_header() {
397397
let markdown = test::render("enum a { b }");
398-
assert str::contains(markdown, "### Enum `a`\n\n");
398+
assert str::contains(markdown, "## Enum `a`\n\n");
399399
}
400400

401401
#[test]
@@ -468,7 +468,7 @@ fn should_write_variant_list_with_signatures() {
468468
}
469469

470470
fn write_res(ctxt: ctxt, doc: doc::resdoc) {
471-
write_header(ctxt, h3, #fmt("Resource `%s`", doc.name));
471+
write_header(ctxt, h2, #fmt("Resource `%s`", doc.name));
472472
write_sig(ctxt, doc.sig);
473473
write_brief(ctxt, doc.brief);
474474
write_desc(ctxt, doc.desc);
@@ -478,7 +478,7 @@ fn write_res(ctxt: ctxt, doc: doc::resdoc) {
478478
#[test]
479479
fn should_write_resource_header() {
480480
let markdown = test::render("resource r(a: bool) { }");
481-
assert str::contains(markdown, "### Resource `r`");
481+
assert str::contains(markdown, "## Resource `r`");
482482
}
483483

484484
#[test]
@@ -537,7 +537,7 @@ mod test {
537537
#[test]
538538
fn write_markdown_should_write_mod_headers() {
539539
let markdown = render("mod moo { }");
540-
assert str::contains(markdown, "## Module `moo`");
540+
assert str::contains(markdown, "# Module `moo`");
541541
}
542542

543543
#[test]

0 commit comments

Comments
 (0)