Skip to content

Commit 8617f0a

Browse files
committed
---
yaml --- r: 11717 b: refs/heads/master c: 57596cb h: refs/heads/master i: 11715: 6659b60 v: v3
1 parent 7ddd707 commit 8617f0a

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
refs/heads/master: 7d686d637241f50e8fbcaa47eee7bcd3c058f097
2+
refs/heads/master: 57596cbe53e826feec2d0fba5293249306d70403
33
refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
44
refs/heads/snap-stage3: 4a81779abd786ff22d71434c6d9a5917ea4cdfff
55
refs/heads/try: 2898dcc5d97da9427ac367542382b6239d9c0bbf

trunk/src/rustdoc/markdown_pass.rs

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,10 @@ fn write_header_(ctxt: ctxt, lvl: hlvl, title: str) {
134134
ctxt.w.write_line("");
135135
}
136136

137+
fn write_lead(ctxt: ctxt, title: str) {
138+
ctxt.w.write_str(#fmt("__%s__: ", title))
139+
}
140+
137141
fn header_kind(doc: doc::itemtag) -> str {
138142
alt doc {
139143
doc::modtag(_) {
@@ -478,7 +482,8 @@ fn write_args(
478482
args: [doc::argdoc]
479483
) {
480484
if vec::is_not_empty(args) {
481-
ctxt.w.write_line("Arguments:");
485+
write_lead(ctxt, "Arguments");
486+
ctxt.w.write_line("");
482487
ctxt.w.write_line("");
483488
vec::iter(args) {|arg| write_arg(ctxt, arg) };
484489
ctxt.w.write_line("");
@@ -505,7 +510,7 @@ fn should_write_argument_list() {
505510
let markdown = test::render(source);
506511
assert str::contains(
507512
markdown,
508-
"Arguments:\n\
513+
"__Arguments__: \n\
509514
\n\
510515
* `b`\n\
511516
* `c`\n\
@@ -533,7 +538,8 @@ fn write_return(
533538
) {
534539
alt doc.desc {
535540
some(d) {
536-
ctxt.w.write_line(#fmt("Return value: %s", d));
541+
write_lead(ctxt, "Return value");
542+
ctxt.w.write_line(d);
537543
ctxt.w.write_line("");
538544
}
539545
none { }
@@ -544,7 +550,7 @@ fn write_return(
544550
fn should_write_return_type_on_new_line() {
545551
let markdown = test::render(
546552
"#[doc(return = \"test\")] fn a() -> int { }");
547-
assert str::contains(markdown, "\nReturn value: test");
553+
assert str::contains(markdown, "\n__Return value__: test");
548554
}
549555

550556
#[test]
@@ -553,7 +559,7 @@ fn should_write_blank_line_between_return_type_and_next_header() {
553559
"#[doc(return = \"test\")] fn a() -> int { } \
554560
fn b() -> int { }"
555561
);
556-
assert str::contains(markdown, "Return value: test\n\n##");
562+
assert str::contains(markdown, "__Return value__: test\n\n##");
557563
}
558564

559565
#[test]
@@ -573,7 +579,8 @@ fn should_write_blank_line_after_return_description() {
573579
fn write_failure(ctxt: ctxt, str: option<str>) {
574580
alt str {
575581
some(str) {
576-
ctxt.w.write_line(#fmt("Failure conditions: %s", str));
582+
write_lead(ctxt, "Failure conditions");
583+
ctxt.w.write_line(str);
577584
ctxt.w.write_line("");
578585
}
579586
none { }
@@ -586,7 +593,7 @@ fn should_write_failure_conditions() {
586593
"#[doc(failure = \"it's the fail\")] fn a () { }");
587594
assert str::contains(
588595
markdown,
589-
"\n\nFailure conditions: it's the fail\n\n");
596+
"\n\n__Failure conditions__: it's the fail\n\n");
590597
}
591598

592599
fn write_const(
@@ -722,7 +729,7 @@ fn should_write_resource_signature() {
722729
fn should_write_resource_args() {
723730
let markdown = test::render("#[doc(args(a = \"b\"))]\
724731
resource r(a: bool) { }");
725-
assert str::contains(markdown, "Arguments:\n\n* `a` - b");
732+
assert str::contains(markdown, "__Arguments__: \n\n* `a` - b");
726733
}
727734

728735
fn write_iface(ctxt: ctxt, doc: doc::ifacedoc) {
@@ -787,7 +794,7 @@ fn should_write_iface_method_signature() {
787794
fn should_write_iface_method_argument_header() {
788795
let markdown = test::render(
789796
"iface a { fn a(b: int); }");
790-
assert str::contains(markdown, "\n\nArguments:\n\n");
797+
assert str::contains(markdown, "\n\n__Arguments__: \n\n");
791798
}
792799

793800
#[test]
@@ -808,14 +815,14 @@ fn should_not_write_iface_method_arguments_if_none() {
808815
fn should_write_iface_method_return_info() {
809816
let markdown = test::render(
810817
"iface a { #[doc(return = \"test\")] fn a() -> int; }");
811-
assert str::contains(markdown, "Return value: test");
818+
assert str::contains(markdown, "__Return value__: test");
812819
}
813820

814821
#[test]
815822
fn should_write_iface_method_failure_conditions() {
816823
let markdown = test::render(
817824
"iface a { #[doc(failure = \"nuked\")] fn a(); }");
818-
assert str::contains(markdown, "Failure conditions: nuked");
825+
assert str::contains(markdown, "__Failure conditions__: nuked");
819826
}
820827

821828
fn write_impl(ctxt: ctxt, doc: doc::impldoc) {
@@ -869,7 +876,7 @@ fn should_write_impl_method_signature() {
869876
fn should_write_impl_method_argument_header() {
870877
let markdown = test::render(
871878
"impl a for int { fn a(b: int) { } }");
872-
assert str::contains(markdown, "\n\nArguments:\n\n");
879+
assert str::contains(markdown, "\n\n__Arguments__: \n\n");
873880
}
874881

875882
#[test]
@@ -890,14 +897,14 @@ fn should_not_write_impl_method_arguments_if_none() {
890897
fn should_write_impl_method_return_info() {
891898
let markdown = test::render(
892899
"impl a for int { #[doc(return = \"test\")] fn a() -> int { } }");
893-
assert str::contains(markdown, "Return value: test");
900+
assert str::contains(markdown, "__Return value__: test");
894901
}
895902

896903
#[test]
897904
fn should_write_impl_method_failure_conditions() {
898905
let markdown = test::render(
899906
"impl a for int { #[doc(failure = \"nuked\")] fn a() { } }");
900-
assert str::contains(markdown, "Failure conditions: nuked");
907+
assert str::contains(markdown, "__Failure conditions__: nuked");
901908
}
902909

903910
fn write_type(

0 commit comments

Comments
 (0)