Stream: rustdoc

Topic: [src] linking insta-stabilized?


view this post on Zulip simulacrum (Sep 12 2021 at 18:42):

I noticed while writing release notes that it looks like https://github.com/rust-lang/rust/pull/84176 was merged as insta-stable, which seems surprising to me.

@Joshua Nelson do you know if you just missed this when r+'ing it? I decollapsed most of the main conversation threads but that PR has a lot of commits, some of which revert each other, and back and forth in the discussion thread (and it seems no clear FCP...) so not sure if this was a decision made intentionally

view this post on Zulip simulacrum (Sep 12 2021 at 18:43):

Generally it seems like we shouldn't be adding things insta-stable, even if it is "just" a CLI flag in some sense.

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:43):

ugh, I could have sworn it was supposed to be unstable

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:43):

this is still in beta, right, we have time to change it?

view this post on Zulip simulacrum (Sep 12 2021 at 18:43):

Yes.

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:44):

wait no, this is unstable: https://github.com/rust-lang/rust/pull/84176/files#diff-9cc5ccbf184245761c03c4d631f96f29d73b3d62aa7c933e9be5dd171b9b9ea3R610

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:44):

what made you think it was stable?

view this post on Zulip simulacrum (Sep 12 2021 at 18:45):

oh, I was looking in config.rs where it's parsed

view this post on Zulip simulacrum (Sep 12 2021 at 18:45):

I guess we define stability at definition time?

view this post on Zulip simulacrum (Sep 12 2021 at 18:46):

I saw some checks for unstable-options in config.rs so assumed wrong, my bad.

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:46):

yeah, these should be set at the time they're defined

view this post on Zulip Joshua Nelson (Sep 12 2021 at 18:47):

the checks for unstable-options are because rustdoc's options are a mess and --output-format json --show-coverage doesn't require -Zunstable-options but --output-format json alone does

view this post on Zulip Elichai Turkel (Sep 19 2021 at 11:14):

When will we see this in the official docs? (doc.rust-lang.org)
I see that this already works in stdrs.dev but not in doc.rust-lang.org/nightly

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 12:32):

I'm completely lost, what are you talking about?

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:08):

@Elichai Turkel this is still unstable and we don't plan to turn it on for libstd until it's stable

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:10):

Speaking of which I don't see a tracking issue - @GuillaumeGomez can you open one?

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:10):

I still have no idea what we're talking about...

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:11):

@GuillaumeGomez --generate-link-to-src

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:11):

Or whatever you named the flag

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:11):

aaaaah

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:11):

the "jump to def" feature

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:11):

ah indeed, didn't open a tracking issue, my bad

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:11):

Opening one right now

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:25):

Here it is: https://github.com/rust-lang/rust/issues/89095

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 13:27):

(If you feel like I missed something, don't hesitate to edit the issue directly!)

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:37):

Thank you!

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:38):

I'm going to remove "check for bugs" if you don't mind, since it's not really actionable

view this post on Zulip Joshua Nelson (Sep 19 2021 at 13:40):

Add support to go to both source definition and documentation page

Hmm, @GuillaumeGomez do you think this needs to block stabilization? It seems useful even without that feature

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 14:06):

For me it is

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 14:06):

it's actually pretty easy to do too

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 14:06):

the biggest blocker is the UI itself imo

view this post on Zulip GuillaumeGomez (Sep 19 2021 at 14:07):

I'll send a PR for it next week if you want :)

view this post on Zulip Joshua Nelson (Sep 19 2021 at 14:16):

Sure, that would be great :)


Last updated: Oct 11 2021 at 22:34 UTC