Skip to content

Resolve intra-doc links in summary desc #86451

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

Jump to bottom
Merged
merged 2 commits into from
Jun 22, 2021
Merged

Resolve intra-doc links in summary desc #86451

merged 2 commits into from
Jun 22, 2021

Conversation

notriddle
Copy link
Contributor

Before:

rustdoc-intra-doc-link-summary-before

After:

rustdoc-intra-doc-link-summary

@rust-highfive
Copy link
Contributor

r? @CraftSpider

(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 18, 2021
@rust-log-analyzer

This comment has been minimized.

# to view
@notriddle
Copy link
Contributor Author

@rustbot label: +A-rustdoc

@rustbot rustbot 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
Contributor

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

@bors r+

@bors
Copy link
Collaborator

bors commented Jun 21, 2021

📌 Commit f67585d has been approved by CraftSpider

@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 21, 2021
fee1-dead added a commit to fee1-dead-contrib/rust that referenced this pull request Jun 22, 2021
@fee1-dead
Rollup merge of rust-lang#86451 - notriddle:notriddle/rustdoc-intra-d…
0ae5ef9 
…oc-link-summary, r=CraftSpider

Resolve intra-doc links in summary desc

Before:

![rustdoc-intra-doc-link-summary-before](https://user-images.githubusercontent.com/1593513/122623069-9d995e80-d04f-11eb-8d46-ec2ec126bb5e.png)

After:

![rustdoc-intra-doc-link-summary](https://user-images.githubusercontent.com/1593513/122623076-a4c06c80-d04f-11eb-967a-f5916871c34b.png)
@fee1-dead fee1-dead mentioned this pull request Jun 22, 2021
Closed
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jun 22, 2021
@JohnTitor
Rollup merge of rust-lang#86451 - notriddle:notriddle/rustdoc-intra-d…
9182179 
…oc-link-summary, r=CraftSpider

Resolve intra-doc links in summary desc

Before:

![rustdoc-intra-doc-link-summary-before](https://user-images.githubusercontent.com/1593513/122623069-9d995e80-d04f-11eb-8d46-ec2ec126bb5e.png)

After:

![rustdoc-intra-doc-link-summary](https://user-images.githubusercontent.com/1593513/122623076-a4c06c80-d04f-11eb-967a-f5916871c34b.png)
This was referenced Jun 22, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 22, 2021
@bors
Auto merge of rust-lang#86545 - JohnTitor:rollup-7sqdhpa, r=JohnTitor
3487be1 
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:master Jun 22, 2021
@rustbot rustbot 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 camelid mentioned this pull request Aug 9, 2021
Closed
camelid added a commit to camelid/rust that referenced this pull request Sep 4, 2021
@camelid
Use summary_opts() for Markdown summaries
208a5fd 
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 notriddle mentioned this pull request Feb 2, 2022
Merged
notriddle added a commit to notriddle/rust that referenced this pull request Feb 16, 2022
@notriddle
rustdoc: resolve intra-doc links when checking HTML
1a6d41c 
Similar to rust-lang#86451

CC rust-lang#67799
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 20, 2022
@bors
Auto merge of rust-lang#93605 - notriddle:notriddle/rustdoc-html-tags…
6d7aa47 
…-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
```
@notriddle notriddle mentioned this pull request Feb 11, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 12, 2023
@matthiaskrgr
Rollup merge of rust-lang#107934 - notriddle:notriddle/intra-doc-link…
bddcbcd 
…-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
@matthiaskrgr
Rollup merge of rust-lang#107934 - notriddle:notriddle/intra-doc-link…
9b50332 
…-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.
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers
No reviews
Assignees

@CraftSpider CraftSpider

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
Milestone
1.55.0
Development

Successfully merging this pull request may close these issues.
6 participants
@notriddle @rust-highfive @rust-log-analyzer @CraftSpider @bors @rustbot