Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Modifies the rendering of constant values in rustdoc. #112167

Closed
wants to merge 4 commits into from
Closed

Modifies the rendering of constant values in rustdoc. #112167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d6cb5f1
Implement item_constant_fixme
sladyn98 Jun 1, 2023
fb95d2e
Fix tests
sladyn98 Jun 1, 2023
e13e5fc
Commit suggestions
sladyn98 Jun 1, 2023
05d3c6e
Commit suggestions and fix tests
sladyn98 Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1491,24 +1491,13 @@ fn item_constant(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, c: &cle
let value = c.value(tcx);
let is_literal = c.is_literal(tcx);
let expr = c.expr(tcx);
if value.is_some() || is_literal {
if is_literal {
write!(w, " = {expr};", expr = Escape(&expr));
} else if let Some(ref value) = value {
write!(w, " = {value};", value = Escape(value));
} else {
w.write_str(";");
}

if !is_literal {
if let Some(value) = &value {
let value_lowercase = value.to_lowercase();
let expr_lowercase = expr.to_lowercase();

if value_lowercase != expr_lowercase
&& value_lowercase.trim_end_matches("i32") != expr_lowercase
{
write!(w, " // {value}", value = Escape(value));
}
}
}
});

write!(w, "{}", document(cx, it, None, HeadingOffset::H2))
Expand Down
4 changes: 2 additions & 2 deletions tests/rustdoc/const-value-display.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#![crate_name = "foo"]

// @has 'foo/constant.HOUR_IN_SECONDS.html'
// @has - '//*[@class="rust item-decl"]//code' 'pub const HOUR_IN_SECONDS: u64 = _; // 3_600u64'
// @has - '//*[@class="rust item-decl"]//code' 'pub const HOUR_IN_SECONDS: u64 = 3_600u64'
pub const HOUR_IN_SECONDS: u64 = 60 * 60;

// @has 'foo/constant.NEGATIVE.html'
// @has - '//*[@class="rust item-decl"]//code' 'pub const NEGATIVE: i64 = _; // -3_600i64'
// @has - '//*[@class="rust item-decl"]//code' 'pub const NEGATIVE: i64 = -3_600i64'
pub const NEGATIVE: i64 = -60 * 60;
20 changes: 5 additions & 15 deletions tests/rustdoc/show-const-contents.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,46 @@
// documentation.

// @hasraw show_const_contents/constant.CONST_S.html 'show this'
// @!hasraw show_const_contents/constant.CONST_S.html '; //'
pub const CONST_S: &'static str = "show this";

// @hasraw show_const_contents/constant.CONST_I32.html '= 42;'
// @!hasraw show_const_contents/constant.CONST_I32.html '; //'
pub const CONST_I32: i32 = 42;

// @hasraw show_const_contents/constant.CONST_I32_HEX.html '= 0x42;'
// @!hasraw show_const_contents/constant.CONST_I32_HEX.html '; //'
pub const CONST_I32_HEX: i32 = 0x42;

// @hasraw show_const_contents/constant.CONST_NEG_I32.html '= -42;'
// @!hasraw show_const_contents/constant.CONST_NEG_I32.html '; //'
pub const CONST_NEG_I32: i32 = -42;

// @hasraw show_const_contents/constant.CONST_EQ_TO_VALUE_I32.html '= 42i32;'
// @!hasraw show_const_contents/constant.CONST_EQ_TO_VALUE_I32.html '// 42i32'
pub const CONST_EQ_TO_VALUE_I32: i32 = 42i32;

// @hasraw show_const_contents/constant.CONST_CALC_I32.html '= _; // 43i32'
// @hasraw show_const_contents/constant.CONST_CALC_I32.html '= 43i32'
pub const CONST_CALC_I32: i32 = 42 + 1;

// @!hasraw show_const_contents/constant.CONST_REF_I32.html '= &42;'
// @!hasraw show_const_contents/constant.CONST_REF_I32.html '; //'
pub const CONST_REF_I32: &'static i32 = &42;

// @hasraw show_const_contents/constant.CONST_I32_MAX.html '= i32::MAX; // 2_147_483_647i32'
// @hasraw show_const_contents/constant.CONST_I32_MAX.html '= 2_147_483_647i32'
pub const CONST_I32_MAX: i32 = i32::MAX;

// @!hasraw show_const_contents/constant.UNIT.html '= ();'
// @!hasraw show_const_contents/constant.UNIT.html '; //'
pub const UNIT: () = ();

pub struct MyType(i32);

// @!hasraw show_const_contents/constant.MY_TYPE.html '= MyType(42);'
// @!hasraw show_const_contents/constant.MY_TYPE.html '; //'
pub const MY_TYPE: MyType = MyType(42);

pub struct MyTypeWithStr(&'static str);

// @!hasraw show_const_contents/constant.MY_TYPE_WITH_STR.html '= MyTypeWithStr("show this");'
// @!hasraw show_const_contents/constant.MY_TYPE_WITH_STR.html '; //'
pub const MY_TYPE_WITH_STR: MyTypeWithStr = MyTypeWithStr("show this");

// @hasraw show_const_contents/constant.PI.html '= 3.14159265358979323846264338327950288f32;'
// @hasraw show_const_contents/constant.PI.html '; // 3.14159274f32'
// @hasraw show_const_contents/constant.PI.html '= 3.14159274f32;'
pub use std::f32::consts::PI;

// @hasraw show_const_contents/constant.MAX.html '= i32::MAX; // 2_147_483_647i32'
// @hasraw show_const_contents/constant.MAX.html '= 2_147_483_647i32'
#[allow(deprecated, deprecated_in_future)]
pub use std::i32::MAX;

Expand All @@ -61,7 +51,7 @@ macro_rules! int_module {
)
}

// @hasraw show_const_contents/constant.MIN.html '= i16::MIN; // -32_768i16'
// @hasraw show_const_contents/constant.MIN.html '= -32_768i16'
int_module!(i16);

// @has show_const_contents/constant.ESCAPE.html //pre '= r#"<script>alert("ESCAPE");</script>"#;'
Expand Down