Skip to content

Accept '!' in intra-doc links #79321

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 1 commit into from
Nov 24, 2020
Merged

Accept '!' in intra-doc links #79321

merged 1 commit into from
Nov 24, 2020

Conversation

camelid
Copy link
Member

@camelid camelid commented Nov 22, 2020

This will allow linking to things like Result<T, !>.

See #77832 (comment).

r? @jyn514

This will allow linking to things like `Result<T, !>`.
@camelid camelid added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Nov 22, 2020
@rust-highfive

This comment has been minimized.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 22, 2020
@camelid
Copy link
Member Author

camelid commented Nov 22, 2020

Probably makes sense to test what happens when you link to ! with [`!`]. I think it should fail, but I should make sure. Waiting on a build to test that.

@jyn514
Copy link
Member

jyn514 commented Nov 22, 2020

@camelid yes, it will fail: #63351

r? @Manishearth - this seems fine to me, but I know you were worried about false positives in the warnings.

@rust-highfive rust-highfive assigned Manishearth and unassigned jyn514 Nov 22, 2020
@Manishearth
Copy link
Member

@bors r+

Should be fine

@bors
Copy link
Collaborator

bors commented Nov 23, 2020

📌 Commit 0b6537a has been approved by Manishearth

@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 Nov 23, 2020
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Nov 24, 2020
Accept '!' in intra-doc links

This will allow linking to things like `Result<T, !>`.

*See <https://github.com/rust-lang/rust/pull/77832#discussion_r528409079>.*

r? `@jyn514`
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 24, 2020
…as-schievink

Rollup of 10 pull requests

Successful merges:

 - rust-lang#76858 (Add exploit mitigations chapter to the rustc book)
 - rust-lang#79310 (Make `fold_item_recur` non-nullable)
 - rust-lang#79312 (Get rid of `doctree::Impl`)
 - rust-lang#79321 (Accept '!' in intra-doc links)
 - rust-lang#79346 (Allow using `-Z fewer-names=no` to retain value names)
 - rust-lang#79351 (Fix typo in `keyword` docs for traits)
 - rust-lang#79354 (BTreeMap: cut out the ceremony around BoxedNode)
 - rust-lang#79358 (BTreeMap/BTreeSet: make public doc more consistent)
 - rust-lang#79367 (Allow disabling TrapUnreachable via -Ztrap-unreachable=no)
 - rust-lang#79374 (Add note to use nightly when using expr in const generics)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 3f36f92 into rust-lang:master Nov 24, 2020
@rustbot rustbot added this to the 1.50.0 milestone Nov 24, 2020
@camelid camelid deleted the intra-doc-bang branch November 24, 2020 18:19
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name 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