Fix const deref methods display #91291

GuillaumeGomez · 2021-11-27T13:39:08Z

Fixes #90855 (more information in the issue).

r? @camelid

src/librustdoc/html/render/mod.rs

src/test/rustdoc/deref-const-fn.rs

src/librustdoc/html/render/mod.rs

GuillaumeGomez · 2021-11-28T13:49:30Z

Updated!

src/librustdoc/html/render/mod.rs

GuillaumeGomez · 2021-11-28T20:02:26Z

@camelid I think you had a great idea: replacing the &str with Symbol could be very interesting. Let's run a perf check.

@bors try @rust-timer queue

rust-timer · 2021-11-28T20:02:27Z

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

bors · 2021-11-28T20:02:34Z

⌛ Trying commit 9e8cd4f0e1f6af9c8d7fa8ee9aed757dd85e1e6f with merge 394b433d1b670f0bf2f0d876a42390d2f07474a4...

bors · 2021-11-28T21:52:58Z

☀️ Try build successful - checks-actions
Build commit: 394b433d1b670f0bf2f0d876a42390d2f07474a4 (394b433d1b670f0bf2f0d876a42390d2f07474a4)

rust-timer · 2021-11-28T21:53:00Z

Queued 394b433d1b670f0bf2f0d876a42390d2f07474a4 with parent e6d2de9, future comparison URL.

rust-timer · 2021-11-28T23:23:35Z

Finished benchmarking commit (394b433d1b670f0bf2f0d876a42390d2f07474a4): comparison url.

Summary: This change led to large relevant improvements 🎉 in compiler performance.

Large improvement in instruction counts (up to -3.9% on incr-unchanged builds of deep-vector)

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR led to changes in compiler perf.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf -perf-regression

camelid · 2021-11-29T00:21:40Z

Some slight doc instructions improvements, and the cleanup is good anyway. The improvements reported in the summary are just deep-vector being spurious as usual.

src/librustdoc/clean/types.rs

src/librustdoc/html/render/mod.rs

src/test/rustdoc/deref-const-fn.rs

src/librustdoc/html/render/mod.rs

src/test/rustdoc/deref-const-fn.rs

camelid · 2021-11-30T20:26:46Z

src/test/rustdoc/deref-const-fn.rs

+
+// @has 'foo/struct.Foo.html'
+// @has - '//*[@id="method.len"]' 'pub fn len(&self) -> usize'
+// @!has - '//*[@id="method.len"]//span[@class="since"]' '1.0.0'


Hmm, shouldn't stability be shown? Or I guess it depends on when the Deref impl was added too.

Weirdly, https://doc.rust-lang.org/nightly/std/string/struct.String.html#deref-methods-str shows regular and const stability, but https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html#deref-methods-Path shows neither. Something fishy's going on with re-exports, since https://doc.rust-lang.org/nightly/alloc/string/struct.String.html#deref-methods-str shows stability for some methods but not all and is missing many methods that the std version has. (I think I opened an issue for part of this at some point.)

Since you already opened the issue, I'll mark this discussion as resolved.

No, the issue I opened was just about how different methods were shown between std and alloc. But I guess this bug is unrelated to this PR?

I thought 1.0.0 without the const version is hidden. Maybe that's why? If there is a stable const version, then we show 1.0.0 (const: 1.xx.0) or const: unstable.

GuillaumeGomez · 2021-11-30T21:48:31Z

Updated!

…lity

camelid · 2021-12-01T22:12:45Z

@bors r+

bors · 2021-12-01T22:12:47Z

📌 Commit 02782bb has been approved by camelid

bors · 2021-12-02T06:11:13Z

⌛ Testing commit 02782bb with merge d9baa36...

bors · 2021-12-02T09:04:33Z

☀️ Test successful - checks-actions
Approved by: camelid
Pushing d9baa36 to master...

rust-timer · 2021-12-02T10:41:05Z

Finished benchmarking commit (d9baa36): comparison url.

Summary: This benchmark run did not return any relevant changes.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Nov 27, 2021

rust-highfive assigned camelid Nov 27, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 27, 2021

GuillaumeGomez commented Nov 27, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Show resolved Hide resolved

camelid reviewed Nov 27, 2021

View reviewed changes

src/test/rustdoc/deref-const-fn.rs Outdated Show resolved Hide resolved

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

camelid 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 Nov 27, 2021

GuillaumeGomez force-pushed the const-deref-method branch from bc3aacb to 985a011 Compare November 28, 2021 13:49

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

camelid reviewed Nov 28, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the const-deref-method branch from 985a011 to 9e8cd4f Compare November 28, 2021 19:57

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Nov 28, 2021

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Nov 28, 2021

camelid reviewed Nov 29, 2021

View reviewed changes

src/librustdoc/clean/types.rs Show resolved Hide resolved

camelid reviewed Nov 29, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

camelid reviewed Nov 29, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

camelid reviewed Nov 29, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Show resolved Hide resolved

camelid reviewed Nov 29, 2021

View reviewed changes

src/test/rustdoc/deref-const-fn.rs Show resolved Hide resolved

GuillaumeGomez force-pushed the const-deref-method branch from 9e8cd4f to d5b49c0 Compare November 29, 2021 09:25

jyn514 reviewed Nov 30, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

src/librustdoc/html/render/mod.rs Outdated Show resolved Hide resolved

camelid reviewed Nov 30, 2021

View reviewed changes

camelid 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 Nov 30, 2021

GuillaumeGomez added 2 commits November 30, 2021 22:46

Fix display for "const" deref methods in rustdoc

588a99b

Add test for const deref methods display

0c1b0f7

GuillaumeGomez force-pushed the const-deref-method branch from 034afd4 to e5aadd2 Compare November 30, 2021 21:47

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

This comment has been minimized.

Sign in to view

GuillaumeGomez added 2 commits November 30, 2021 22:53

Improve code by replacing &str with Symbol in render_stability_since_raw

b647c90

Return ConstStability instead of &ConstStability in Item::const_stabi…

02782bb

…lity

GuillaumeGomez force-pushed the const-deref-method branch from e5aadd2 to 02782bb Compare November 30, 2021 21:53

camelid approved these changes Dec 1, 2021

View reviewed changes

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-review Status: Awaiting review from the assignee but also interested parties. labels Dec 1, 2021

bors added the merged-by-bors This PR was explicitly merged by bors. label Dec 2, 2021

bors merged commit d9baa36 into rust-lang:master Dec 2, 2021

rustbot added this to the 1.59.0 milestone Dec 2, 2021

GuillaumeGomez deleted the const-deref-method branch December 2, 2021 09:11

This was referenced Dec 2, 2021

Remove clean::Function::header and calculate it on-demand #91217

Closed

rustdoc: show trait implementors in sidebar #91277

Closed

rustdoc: calculate visibility on-demand #91408

Closed

fmease mentioned this pull request Aug 18, 2022

"Methods from Deref<Target = [T]>" doesn't render const #100680

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix const deref methods display #91291

Fix const deref methods display #91291

GuillaumeGomez commented Nov 27, 2021

GuillaumeGomez commented Nov 28, 2021

GuillaumeGomez commented Nov 28, 2021

rust-timer commented Nov 28, 2021

bors commented Nov 28, 2021

bors commented Nov 28, 2021

rust-timer commented Nov 28, 2021

rust-timer commented Nov 28, 2021

camelid commented Nov 29, 2021

camelid Nov 30, 2021

GuillaumeGomez Nov 30, 2021

camelid Dec 1, 2021 •

edited

Loading

fee1-dead Dec 2, 2021

GuillaumeGomez commented Nov 30, 2021

This comment has been minimized.

camelid commented Dec 1, 2021

bors commented Dec 1, 2021

bors commented Dec 2, 2021

bors commented Dec 2, 2021

rust-timer commented Dec 2, 2021

Fix const deref methods display #91291

Fix const deref methods display #91291

Conversation

GuillaumeGomez commented Nov 27, 2021

GuillaumeGomez commented Nov 28, 2021

GuillaumeGomez commented Nov 28, 2021

rust-timer commented Nov 28, 2021

bors commented Nov 28, 2021

bors commented Nov 28, 2021

rust-timer commented Nov 28, 2021

rust-timer commented Nov 28, 2021

camelid commented Nov 29, 2021

camelid Nov 30, 2021

Choose a reason for hiding this comment

GuillaumeGomez Nov 30, 2021

Choose a reason for hiding this comment

camelid Dec 1, 2021 • edited Loading

Choose a reason for hiding this comment

fee1-dead Dec 2, 2021

Choose a reason for hiding this comment

GuillaumeGomez commented Nov 30, 2021

This comment has been minimized.

camelid commented Dec 1, 2021

bors commented Dec 1, 2021

bors commented Dec 2, 2021

bors commented Dec 2, 2021

rust-timer commented Dec 2, 2021

camelid Dec 1, 2021 •

edited

Loading