Skip to content

rustdoc: remove tuple link on round braces #98105

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 3 commits into from
Jun 19, 2022

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented Jun 14, 2022

This is #98069 but for tuples. The reasoning is the same:

  • This PR also changes it so that tuples with all-generic elements still link to the primitive.tuple.html page, just like slices. So there still plenty of on-ramps for anybody who doesn't know about it.
  • It's too hard to see when round braces are a separate link from the type inside of them.
  • It's too hard to click even if you do notice them.

Before:

After:

This is 682889f but for tuples. The
reasoning is the same:

* This commit also changes it so that tuples with all-generic elements still
  link to the primitive.tuple.html page, just like slices. So there still
  plenty of on-ramps for anybody who doesn't know about it.
* It's too hard to see when round braces are a separate link from the type
  inside of them.
* It's too hard to click even if you do notice them.
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 14, 2022
@rust-highfive
Copy link
Contributor

r? @jsha

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 14, 2022
@jsha
Copy link
Contributor

jsha commented Jun 18, 2022

The code and the UI look good. Could you add a test along the lines of #98069?

@notriddle
Copy link
Contributor Author

@jsha Okay, test cases added.

@jsha
Copy link
Contributor

jsha commented Jun 18, 2022

Great! r=me once tests pass.

@notriddle
Copy link
Contributor Author

@bors r=jsha

@bors
Copy link
Collaborator

bors commented Jun 18, 2022

📌 Commit 29a9f36 has been approved by jsha

@bors 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 Jun 18, 2022
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Jun 19, 2022
…jsha

rustdoc: remove tuple link on round braces

This is rust-lang#98069 but for tuples. The reasoning is the same:

* This PR also changes it so that tuples with all-generic elements still link to the primitive.tuple.html page, just like slices. So there still plenty of on-ramps for anybody who doesn't know about it.
* It's too hard to see when round braces are a separate link from the type inside of them.
* It's too hard to click even if you do notice them.

Before:

* impl [ToSocketAddrs](https://doc.rust-lang.org/nightly/std/net/trait.ToSocketAddrs.html) for [(](https://doc.rust-lang.org/nightly/std/primitive.tuple.html)[IpAddr](https://doc.rust-lang.org/nightly/std/net/enum.IpAddr.html), [u16](https://doc.rust-lang.org/nightly/std/primitive.u16.html)[)](https://doc.rust-lang.org/nightly/std/primitive.tuple.html)
* impl<K, V> [FromIterator](https://notriddle.com/notriddle-rustdoc-test/std/iter/trait.FromIterator.html)<[(](https://notriddle.com/notriddle-rustdoc-test/std/primitive.tuple.html)K, V[)](https://notriddle.com/notriddle-rustdoc-test/std/primitive.tuple.html)> for [BTreeMap](https://notriddle.com/notriddle-rustdoc-test/std/collections/struct.BTreeMap.html)<K, V>

After:

* impl [ToSocketAddrs](https://doc.rust-lang.org/nightly/std/net/trait.ToSocketAddrs.html) for ([IpAddr](https://doc.rust-lang.org/nightly/std/net/enum.IpAddr.html), [u16](https://doc.rust-lang.org/nightly/std/primitive.u16.html))
* impl<K, V> [FromIterator](https://notriddle.com/notriddle-rustdoc-test/std/iter/trait.FromIterator.html)<[(K, V)](https://notriddle.com/notriddle-rustdoc-test/std/primitive.tuple.html)> for [BTreeMap](https://notriddle.com/notriddle-rustdoc-test/std/collections/struct.BTreeMap.html)<K, V>
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 19, 2022
Rollup of 5 pull requests

Successful merges:

 - rust-lang#98105 (rustdoc: remove tuple link on round braces)
 - rust-lang#98136 (Rename `impl_constness` to `constness`)
 - rust-lang#98146 (Remove --memory-init-file flag when linking with Emscripten)
 - rust-lang#98219 (Skip late bound regions in GATSubstCollector)
 - rust-lang#98233 (Remove accidental uses of `&A: Allocator`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 3174a69 into rust-lang:master Jun 19, 2022
@rustbot rustbot added this to the 1.63.0 milestone Jun 19, 2022
@notriddle notriddle deleted the notriddle/tuple-links branch June 25, 2022 23:24
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants