From 7d686d637241f50e8fbcaa47eee7bcd3c058f097 Mon Sep 17 00:00:00 2001
From: Brian Anderson <banderson@mozilla.com>
Date: Thu, 8 Mar 2012 13:48:21 -0800
Subject: [PATCH] rustdoc: Format return values consistently
---
src/rustdoc/markdown_pass.rs | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/rustdoc/markdown_pass.rs b/src/rustdoc/markdown_pass.rs
index 32c178de00b..5d57f650bb0 100644
--- a/src/rustdoc/markdown_pass.rs
+++ b/src/rustdoc/markdown_pass.rs
@@ -533,7 +533,7 @@ fn write_return(
) {
alt doc.desc {
some(d) {
- ctxt.w.write_line(#fmt("Returns - %s", d));
+ ctxt.w.write_line(#fmt("Return value: %s", d));
ctxt.w.write_line("");
}
none { }
@@ -544,7 +544,7 @@ fn write_return(
fn should_write_return_type_on_new_line() {
let markdown = test::render(
"#[doc(return = \"test\")] fn a() -> int { }");
- assert str::contains(markdown, "\nReturns - test");
+ assert str::contains(markdown, "\nReturn value: test");
}
#[test]
@@ -553,13 +553,13 @@ fn should_write_blank_line_between_return_type_and_next_header() {
"#[doc(return = \"test\")] fn a() -> int { } \
fn b() -> int { }"
);
- assert str::contains(markdown, "Returns - test\n\n##");
+ assert str::contains(markdown, "Return value: test\n\n##");
}
#[test]
fn should_not_write_return_type_when_there_is_none() {
let markdown = test::render("fn a() { }");
- assert !str::contains(markdown, "Returns");
+ assert !str::contains(markdown, "Return value");
}
#[test]
@@ -808,7 +808,7 @@ fn should_not_write_iface_method_arguments_if_none() {
fn should_write_iface_method_return_info() {
let markdown = test::render(
"iface a { #[doc(return = \"test\")] fn a() -> int; }");
- assert str::contains(markdown, "Returns - test");
+ assert str::contains(markdown, "Return value: test");
}
#[test]
@@ -890,7 +890,7 @@ fn should_not_write_impl_method_arguments_if_none() {
fn should_write_impl_method_return_info() {
let markdown = test::render(
"impl a for int { #[doc(return = \"test\")] fn a() -> int { } }");
- assert str::contains(markdown, "Returns - test");
+ assert str::contains(markdown, "Return value: test");
}
#[test]