rustdoc documents massive constant | Rust Programming Language Community | Page 1

thin sparrow Jul 22, 2022, 3:28 PM

#

rustdoc has gone back and forth on whether to show constant values for various reasons:
https://github.com/rust-lang/rust/pull/53409
https://github.com/rust-lang/rust/pull/66221

GitHub

Don't show associated const value anymore by GuillaumeGomez · Pull ...

Part of #44348.
Before:

After:

cc @nox
r? @QuietMisdreavus

GitHub

Show the actual value of constant values in the documentation by oh...

Fixes #66099, making rustdoc show evaluated constant scalar values.

where main.rs is
pub const VAL3: i32 = i32::max_value();
pub const VAL4: i32 = i32::max_value() - 1;

As a fallback, when a cons...

#

this suggests to me that "let the crate author control it" might be welcomed as letting these different situations be handled differently

#

(I don't see an existing issue for that)

remote island Jul 23, 2022, 2:06 AM

#

https://github.com/rust-lang/rust/issues/97933

GitHub

Rustdoc displays private internals of associated constants (regress...

pub struct Struct { private: (), } impl Struct { pub const CONST: Self = Struct { private: () }; } Correct: Incorrect: I used the following script to bisect: #!/bin/bash cargo doc &&amp...

#

this appears to be the relevant issue

#

https://cdn.discordapp.com/attachments/950533914760458340/1000204766858727475/unknown.png

#

it's closed because a hack was PRed

#

How do I get rustdoc to... not?

#

the constant is generated using a macro

silver lichen Jul 22, 2022, 8:44 AM

#

lmao

#

you might want to use it through another constant?

#

i.e. set the value of EDGES to a private constant REAL_EDGES

remote island Jul 22, 2022, 9:12 AM

#

would be nice if there was a rustdoc option for that

#rustdoc documents massive constant