#[doc(inline)] sym_generated

[LeSeulArtichaut]

Manually doc-inlines rustc_span::sym_generated into sym.
Previously the docs would not get inlined, causing the symbols to be undocumented as sym_generated is private.

r? @jyn514

[jyn514]

Can you show a screenshot of what the new docs look like? The fastest way I know is to rebase over #79540 and then x.py doc --stage 0 compiler/rustc, but if you're not feeling adventurous, x.py doc --stage 1 compiler/rustc will work fine. You'll have to set compiler-docs = true in config.toml first.

[jyn514]

Also just for the record: I expect this is a bug in rustdoc related to #77862 somehow, but this fix seems fine in the meantime.

[crlf0710]

@LeSeulArtichaut Ping from triage! What's the current status of this?

[jyn514]

Hmm, it looks like #77862 did not fix this: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/symbol/sym/index.html
@LeSeulArtichaut could you open a rustdoc issue? This workaround seems fine in the meantime.

[LeSeulArtichaut]

Here's a screenshot of ./x.py doc --stage 0 compiler/rustc with this PR:

(Sorry for taking so much time 😕)

[LeSeulArtichaut]

Hmm, it looks like #77862 did not fix this: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/symbol/sym/index.html
@LeSeulArtichaut could you open a rustdoc issue? This workaround seems fine in the meantime.

Should I also leave a FIXME referencing the issue?

[jyn514]

Hmm, it looks like #77862 did not fix this: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/symbol/sym/index.html
@LeSeulArtichaut could you open a rustdoc issue? This workaround seems fine in the meantime.

Should I also leave a FIXME referencing the issue?

Sure, sounds good to me, thanks :)

[petrochenkov]

FWIW, the module kw above has an exactly equivalent reexport (pub use super::kw_generated::*;), it should probably be treated in the same way.

[camelid]

Is this still waiting on the author?

[jyn514]

Yes, @LeSeulArtichaut can you please also add #[doc(inline)] to pub use kw_generated::*? r=me after that.

[jyn514]

If you have time to open an issue that would be helpful too, but I won't block on that.

[LeSeulArtichaut]

kw does render correctly though

[jyn514]

Well here's the issue:

$ cargo expand
pub mod symbol {
    //! An "interner" is a data structure that associates values with usize tags and
    //! allows bidirectional lookup; i.e., given a value, one can easily find the
    //! type, and vice versa.
    use rustc_arena::DroplessArena;
    use rustc_data_structures::fx::FxHashMap;
    use rustc_data_structures::stable_hasher::{HashStable, StableHasher, ToStableHashKey};
    use rustc_macros::HashStable_Generic;
    use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
    use std::cmp::{Ord, PartialEq, PartialOrd};
    use std::fmt;
    use std::hash::{Hash, Hasher};
    use std::str;
    use crate::{Edition, Span, DUMMY_SP, SESSION_GLOBALS};
    const SYMBOL_DIGITS_BASE: u32 = 1211u32;
    #[doc(hidden)]
    #[allow(non_upper_case_globals)]
    mod kw_generated {
        // ...

Can you change the proc-macro to remove doc(hidden) instead?

cc #81980.

[LeSeulArtichaut]

For both sym and kw? Or just sym?

[jyn514]

Oh hmm, now I'm confused again - doc(hidden) is on both module, but only one of them is hidden. I don't know if it's worth looking into this further, up to you.

@bors delegate=LeSeulArtichaut

[bors]

✌️ @LeSeulArtichaut can now approve this pull request

[LeSeulArtichaut]

With exams coming up, I won't have time to investigate this in the near future. I think this should be merged so the documentation can be improved immediately.

@bors r=jyn514 rollup

[bors]

📌 Commit 240907b has been approved by jyn514