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

rustdoc failed to pick up method summary comments in some cases #46783

Closed
nodakai opened this issue Dec 17, 2017 · 1 comment · Fixed by #58448
Closed

rustdoc failed to pick up method summary comments in some cases #46783

nodakai opened this issue Dec 17, 2017 · 1 comment · Fixed by #58448
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nodakai
Copy link
Contributor

nodakai commented Dec 17, 2017

https://doc.rust-lang.org/nightly/std/?search=max_value

i8::max_value(), u8::max_value() and a few others have summaries as given in the source code, but i32::max_value(), u32::max_value() and a few others somehow don't.

This is perplexing when we recall the max_value() method impls are generated by macros https://github.com/rust-lang/rust/blob/master/src/libcore/num/mod.rs#L100
@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Dec 18, 2017
@GuillaumeGomez
Copy link
Member

cc @rust-lang/dev-tools

I'll try to take a look in the next days.

@jkordish jkordish added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Jan 31, 2018
@steveklabnik steveklabnik removed the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label May 29, 2018
@euclio euclio mentioned this issue Feb 14, 2019
Merged
Centril added a commit to Centril/rust that referenced this issue Feb 14, 2019
@Centril
Rollup merge of rust-lang#58448 - euclio:missing-summaries, r=QuietMi…
2439466 
…sdreavus

rustdoc: mask `compiler_builtins` docs

Fixes rust-lang#46783.

I wasn't able to fully confirm the underlying cause, but my theory is that functions in `compiler_builtins` were overwriting functions with the same names in libcore in the search index. Since the functions in `compiler_builtins` didn't have docs, that's why they weren't appearing in the results.

Masking the `compiler_builtins` crate fixes the search results. It appears that this crate was accidentally unmasked in rust-lang#49503.
kennytm added a commit to kennytm/rust that referenced this issue Feb 16, 2019
@kennytm
Rollup merge of rust-lang#58448 - euclio:missing-summaries, r=QuietMi…
762b988 
…sdreavus

rustdoc: mask `compiler_builtins` docs

Fixes rust-lang#46783.

I wasn't able to fully confirm the underlying cause, but my theory is that functions in `compiler_builtins` were overwriting functions with the same names in libcore in the search index. Since the functions in `compiler_builtins` didn't have docs, that's why they weren't appearing in the results.

Masking the `compiler_builtins` crate fixes the search results. It appears that this crate was accidentally unmasked in rust-lang#49503.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. 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.

rustdoc: mask compiler_builtins docs euclio/rust
4 participants
@steveklabnik @jkordish @nodakai @GuillaumeGomez