Skip to content

Resolve intra-doc links in summary desc - #86451

Merged
bors merged 2 commits into
rust-lang:masterfrom
notriddle:notriddle/rustdoc-intra-doc-link-summary
Jun 22, 2021
Merged

Resolve intra-doc links in summary desc#86451
bors merged 2 commits into
rust-lang:masterfrom
notriddle:notriddle/rustdoc-intra-doc-link-summary

Conversation

@notriddle

Copy link
Copy Markdown
Contributor

Before:

rustdoc-intra-doc-link-summary-before

After:

rustdoc-intra-doc-link-summary

@rust-highfive

Copy link
Copy Markdown
Contributor

r? @CraftSpider

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 18, 2021
@rust-log-analyzer

This comment has been minimized.

@notriddle

Copy link
Copy Markdown
ContributorAuthor

@rustbot label: +A-rustdoc

@rustbotrustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 21, 2021
@CraftSpider

Copy link
Copy Markdown
Contributor

This makes the summaries look much nicer with links, thanks!

@bors r+

@bors

bors commented Jun 21, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit f67585d has been approved by CraftSpider

@borsbors 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 21, 2021
fee1-dead added a commit to fee1-dead-contrib/rust that referenced this pull request Jun 22, 2021
@fee1-deadfee1-dead mentioned this pull request Jun 22, 2021
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jun 22, 2021
This was referenced Jun 22, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 22, 2021
Rollup of 6 pull requests
Successful merges:
- rust-lang#86393 (Add regression test for issue rust-lang#52025)
- rust-lang#86402 (rustdoc: add optional woff2 versions of Source Serif and Source Code)
- rust-lang#86451 (Resolve intra-doc links in summary desc)
- rust-lang#86501 (Cleanup handling of `crate_name` for doctests)
- rust-lang#86517 (Fix `unused_unsafe` around `await`)
- rust-lang#86537 (Mark some edition tests as check-pass)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 555fbd7 into rust-lang:masterJun 22, 2021
@rustbotrustbot added this to the 1.55.0 milestone Jun 22, 2021
@notriddle
notriddle deleted the notriddle/rustdoc-intra-doc-link-summary branch June 22, 2021 16:35
camelid added a commit to camelid/rust that referenced this pull request Sep 4, 2021
It was accidentally changed to use `opts()` in rust-lang#86451.
I also renamed `opts()` to `main_body_opts()` to make this kind of
accidental change less likely.
notriddle added a commit to notriddle/rust that referenced this pull request Feb 16, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 20, 2022
…-resolve, r=GuillaumeGomez
rustdoc: resolve intra-doc links when checking HTML
Similar to rust-lang#86451
CC rust-lang#67799
Given this test case:
```rust
#![warn(rustdoc::invalid_html_tags)]
#![warn(rustdoc::broken_intra_doc_links)]
pub struct ExistentStruct<T>(T);
/// This [test][ExistentStruct<i32>] thing!
pub struct NoError;
```
This pull request silences the following, spurious warning:
```text
warning: unclosed HTML tag `i32`
--> test.rs:6:31
|
6 | /// This [test][ExistentStruct<i32>] thing!
| ^^^^^
|
note: the lint level is defined here
--> test.rs:1:9
|
1 | #![warn(rustdoc::invalid_html_tags)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
help: try marking as source code
|
6 | /// This [test][`ExistentStruct<i32>`] thing!
| + +
warning: 1 warning emitted
```
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 12, 2023
…-meta-description, r=camelid,GuillaumeGomez
rustdoc: account for intra-doc links in `<meta name="description">`
Similar to rust-lang#86451, but for the SEO descriptions instead of the search descriptions.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 12, 2023
…-meta-description, r=camelid,GuillaumeGomez
rustdoc: account for intra-doc links in `<meta name="description">`
Similar to rust-lang#86451, but for the SEO descriptions instead of the search descriptions.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant 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

@notriddle@rust-highfive@rust-log-analyzer@CraftSpider@bors@rustbot