Do not render unstable items for rustc doc #74351

tesuji · 2020-07-15T04:01:21Z

See the zulip conversation at https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc.20doc.3A.20.22internal.20compiler.20API.22.20warns.20are.20everywhere!/near/203850782

Before:

After:

Nothing changes in unstable items of std:
Before:

After:

Closes #54682

rust-highfive · 2020-07-15T04:01:25Z

r? @ollie27

(rust_highfive has picked a reviewer for you, use r? to override)

tesuji · 2020-07-15T04:03:39Z

r? @Mark-Simulacrum

ollie27

This PR will fix #54682.

The now unused CSS should be removed:

rust/src/librustdoc/html/static/themes/light.css

Lines 176 to 178 in c714eae

    
           .stab.internal a { 
        
           	color: #304FFE; 
        
           }

and

rust/src/librustdoc/html/static/themes/light.css

Line 218 in c714eae

.stab.internal { background: #FFB9B3; border-color: #B71C1C; }

for every theme.

src/librustdoc/externalfiles.rs

ollie27 · 2020-07-15T09:33:06Z

src/test/rustdoc/internal.rs

-// compile-flags: -Z force-unstable-if-unmarked
-
-// @matches internal/index.html '//*[@class="docblock-short"]/span[@class="stab internal"]' \
-//      'Internal'


This test should be modified to check that the unstable marker is not added for rustc_private.

GuillaumeGomez · 2020-07-15T09:46:59Z

Also: can you remove the changes coming from #74359 please? It makes the changes more noisy than necessary.

As rustc is permanently unstable. So marking every items with unstable is essential useless.

tesuji · 2020-07-15T11:09:49Z

Resolved comment reviews.

Mark-Simulacrum · 2020-07-15T19:10:07Z

src/librustdoc/html/render.rs

+    // Render unstable items. But don't render "rustc_private" crates (internal compiler crates).
+    // Those crates are permanently unstable so it makes no sense to render "unstable" everywhere.
+    if let Some(stab) = item.stability.as_ref().filter(|stab| {
+        stab.level == stability::Unstable && stab.feature.as_deref() != Some("rustc_private")


nit: we should be comparing against rustc_span::sym::rustc_private to avoid hitting the string interner lock here.

I would love to. But stab.feature is Option<String>. I have a discussion for merging Stability and more between rustdoc and rustc APIs https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Merge.20Stability.20in.20rustc_attr.20and.20rustdoc .

Oh right this is rustdoc-cleaned stability. Fine as is then.

Mark-Simulacrum · 2020-07-15T19:10:54Z

r=me with nit resolved (where I left the comment and elsewhere in modified code)

Mark-Simulacrum · 2020-07-16T13:50:53Z

@bors r+

bors · 2020-07-16T13:50:54Z

📌 Commit 47fea96 has been approved by Mark-Simulacrum

…er-warns, r=Mark-Simulacrum Do not render unstable items for rustc doc See the zulip conversion: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc.20doc.3A.20.22internal.20compiler.20API.22.20warns.20are.20everywhere!/near/203850782 Before: ![image](https://user-images.githubusercontent.com/15225902/87501971-9cff8780-c68a-11ea-93b4-ea53ce18a77b.png) After: ![image](https://user-images.githubusercontent.com/15225902/87501985-a7218600-c68a-11ea-81c0-a6b5b120832c.png) Nothing changes in unstable items of std: Before: ![image](https://user-images.githubusercontent.com/15225902/87502004-b7d1fc00-c68a-11ea-9224-a27a1d2a81d6.png) After: ![image](https://user-images.githubusercontent.com/15225902/87502018-c0c2cd80-c68a-11ea-9773-4c63158025cb.png) Closes rust-lang#54682

@ghost

…arth Rollup of 8 pull requests Successful merges: - rust-lang#73101 (Resolve items for cross-crate imports relative to the original module) - rust-lang#73269 (Enable some timeouts in SGX platform) - rust-lang#74033 (Add build support for Cargo's build-std feature.) - rust-lang#74351 (Do not render unstable items for rustc doc) - rust-lang#74357 (Some `Symbol` related improvements) - rust-lang#74371 (Improve ayu rustdoc theme) - rust-lang#74386 (Add RISC-V GNU/Linux to src/tools/build-manifest as a host platform) - rust-lang#74398 (Clean up E0723 explanation) Failed merges: r? @ghost

rust-highfive assigned ollie27 Jul 15, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 15, 2020

rust-highfive assigned Mark-Simulacrum and unassigned ollie27 Jul 15, 2020

tesuji force-pushed the remove-rustc-internal-compiler-warns branch 5 times, most recently from 78861c7 to e182b74 Compare July 15, 2020 07:52

ollie27 reviewed Jul 15, 2020

View reviewed changes

tesuji added 2 commits July 15, 2020 10:53

Don't render unstable for rustc docs

f970632

As rustc is permanently unstable. So marking every items with unstable is essential useless.

Remove unused CSS rules for internal rustc items

47fea96

tesuji force-pushed the remove-rustc-internal-compiler-warns branch from e182b74 to 47fea96 Compare July 15, 2020 10:53

Mark-Simulacrum reviewed Jul 15, 2020

View reviewed changes

Mark-Simulacrum added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 15, 2020

tesuji requested a review from Mark-Simulacrum July 16, 2020 13:42

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 16, 2020

Manishearth mentioned this pull request Jul 16, 2020

Rollup of 18 pull requests #74401

Closed

Manishearth mentioned this pull request Jul 16, 2020

Rollup of 22 pull requests #74403

Closed

Manishearth mentioned this pull request Jul 16, 2020

Rollup of 9 pull requests #74412

Closed

Manishearth mentioned this pull request Jul 16, 2020

Rollup of 9 pull requests #74414

Closed

Manishearth mentioned this pull request Jul 16, 2020

Rollup of 9 pull requests #74415

Closed

This was referenced Jul 17, 2020

Rollup of 8 pull requests #74421

Closed

Rollup of 8 pull requests #74422

Merged

bors merged commit 0e70884 into rust-lang:master Jul 17, 2020

tesuji deleted the remove-rustc-internal-compiler-warns branch July 17, 2020 03:39

tesuji mentioned this pull request Jul 19, 2020

nightly-rustc docs no longer document private items #74511

Closed

cuviper added this to the 1.47.0 milestone May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not render unstable items for rustc doc #74351

Do not render unstable items for rustc doc #74351

tesuji commented Jul 15, 2020 •

edited

Loading

rust-highfive commented Jul 15, 2020

tesuji commented Jul 15, 2020

ollie27 left a comment

ollie27 Jul 15, 2020

tesuji Jul 15, 2020

GuillaumeGomez commented Jul 15, 2020

tesuji commented Jul 15, 2020

Mark-Simulacrum Jul 15, 2020

tesuji Jul 16, 2020 •

edited

Loading

Mark-Simulacrum Jul 16, 2020

Mark-Simulacrum commented Jul 15, 2020

Mark-Simulacrum commented Jul 16, 2020

bors commented Jul 16, 2020

Do not render unstable items for rustc doc #74351

Do not render unstable items for rustc doc #74351

Conversation

tesuji commented Jul 15, 2020 • edited Loading

rust-highfive commented Jul 15, 2020

tesuji commented Jul 15, 2020

ollie27 left a comment

Choose a reason for hiding this comment

ollie27 Jul 15, 2020

Choose a reason for hiding this comment

tesuji Jul 15, 2020

Choose a reason for hiding this comment

GuillaumeGomez commented Jul 15, 2020

tesuji commented Jul 15, 2020

Mark-Simulacrum Jul 15, 2020

Choose a reason for hiding this comment

tesuji Jul 16, 2020 • edited Loading

Choose a reason for hiding this comment

Mark-Simulacrum Jul 16, 2020

Choose a reason for hiding this comment

Mark-Simulacrum commented Jul 15, 2020

Mark-Simulacrum commented Jul 16, 2020

bors commented Jul 16, 2020

tesuji commented Jul 15, 2020 •

edited

Loading

tesuji Jul 16, 2020 •

edited

Loading