Skip to content

rustdoc: std::f32::consts (re-exported module) members are not documented #19185

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
Closed
SimonSapin opened this issue Nov 21, 2014 · 5 comments · Fixed by #19793
Closed

rustdoc: std::f32::consts (re-exported module) members are not documented #19185

SimonSapin opened this issue Nov 21, 2014 · 5 comments · Fixed by #19793
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@SimonSapin
Copy link
Contributor

http://doc.rust-lang.org/std/f32/consts/ and http://doc.rust-lang.org/std/f64/consts/ are currently empty, except for the module’s docstring. Compare with http://doc.rust-lang.org/core/f32/consts/ and http://doc.rust-lang.org/core/f64/consts/
@kmcallister kmcallister added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Nov 23, 2014
@steveklabnik
Copy link
Member

I don't know the best way to tackle this, as I know little about re-exported documentation. @huonw do you know?

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 25, 2014
@SimonSapin
Copy link
Contributor Author

To clarify: I think this is a bug in rustdoc code rather than documentation that needs to be written.

@steveklabnik
Copy link
Member

Agreed.

@tomjakubowski
Copy link
Contributor

This is a dupe of #15821 (although that should be updated to reflect the static -> const split).

@tomjakubowski
Copy link
Contributor

Not actually a dupe of #15821, my mistake.

@tomjakubowski tomjakubowski mentioned this issue Dec 12, 2014
Merged
tomjakubowski added a commit to tomjakubowski/rust that referenced this issue Dec 12, 2014
@tomjakubowski
rustdoc: Properly inline const items
25223c8 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821
brson added a commit to brson/rust that referenced this issue Dec 12, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
eb2ce7f 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
brson added a commit to brson/rust that referenced this issue Dec 13, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
5b4ba62 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
tomjakubowski added a commit to tomjakubowski/rust that referenced this issue Dec 13, 2014
@tomjakubowski
metadata: Encode attributes for const items
31f75ac 
Fix rust-lang#19773

Together with rust-lang#19774 (which this is rebased on):

Fix rust-lang#18156, fix rust-lang#19722, fix rust-lang#19185
@tomjakubowski tomjakubowski mentioned this issue Dec 13, 2014
Merged
brson added a commit to brson/rust that referenced this issue Dec 15, 2014
@brson
rollup merge of rust-lang#19774: tomjakubowski/rustdoc-consts-statics
3673486 
Build `clean::ConstantItem` values in the `inline` module and
pretty-print the AST for inlined const items.

Doc strings are still missing from inlined constants (see rust-lang#19773).

Partially address rust-lang#18156, rust-lang#19722, rust-lang#19185

Fix rust-lang#15821

r? @alexcrichton
brson added a commit to brson/rust that referenced this issue Dec 15, 2014
@brson
rollup merge of rust-lang#19793: tomjakubowski/metadata-const-attrs
77d2a11 
Fix rust-lang#19773

Together with rust-lang#19774 (which this is rebased on):

Fix rust-lang#18156, fix rust-lang#19722, fix rust-lang#19185

r? @alexcrichton (since this was your suggestion!)
lnicola added a commit to lnicola/rust that referenced this issue Feb 24, 2025
@lnicola
Merge pull request rust-lang#19185 from BenjaminBrienen/patch-3
36768cd 
Update architecture.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

metadata: Encode attributes for const items tomjakubowski/rust
4 participants
@steveklabnik @SimonSapin @kmcallister @tomjakubowski