Skip to content

Include all contents of first line of scraped item in Rustdoc #93568

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

Conversation

willcrichton
Copy link
Contributor

@willcrichton willcrichton commented Feb 2, 2022

This fixes #93528. When scraping examples, it extends the span of the enclosing item to include all characters up to the start of the first line of the span.

r? @camelid

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 2, 2022
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 2, 2022
@camelid
Copy link
Member

camelid commented Feb 3, 2022

Sorry, I don't think I'll have time to review this. r? rust-lang/rustdoc

@rust-highfive rust-highfive assigned CraftSpider and unassigned camelid Feb 3, 2022
@willcrichton
Copy link
Contributor Author

Oh I didn't know you could tag an org as a suggested reviewer. I will do that in the future!

@camelid
Copy link
Member

camelid commented Feb 6, 2022

@willcrichton you can also just skip the r?, and highfive will pick a reviewer based on which code you modified :)

@CraftSpider
Copy link
Contributor

Looks good to me. Thanks for the patience on the review delay
@bors r+

@bors
Copy link
Collaborator

bors commented Feb 7, 2022

📌 Commit 1ab23bd 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 Feb 7, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 8, 2022
…askrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#86497 (Add {floor,ceil}_char_boundary methods to str)
 - rust-lang#92695 (Add `#[no_coverage]` tests for nested functions)
 - rust-lang#93521 (Fix hover effects in sidebar)
 - rust-lang#93568 (Include all contents of first line of scraped item in Rustdoc)
 - rust-lang#93569 (rustdoc: correct unclosed HTML tags as generics)
 - rust-lang#93672 (update comment wrt const param defaults)
 - rust-lang#93715 (Fix horizontal trim for block doc comments)
 - rust-lang#93721 (rustdoc: Special-case macro lookups less)
 - rust-lang#93728 (Add in ValuePair::Term)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 3389792 into rust-lang:master Feb 8, 2022
@rustbot rustbot added this to the 1.60.0 milestone Feb 8, 2022
# 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.

Indentation of items is lost in examples in documentation with -Zrustdoc-scrape-examples
6 participants