Skip to content

add extra linebreaks so rustdoc can identify the first sentence #129793

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 2, 2024
Merged

add extra linebreaks so rustdoc can identify the first sentence #129793

merged 1 commit into from
Sep 2, 2024

Conversation

lolbinarycat
Copy link
Contributor

there should probably be a lint against this in rustdoc, it causes too many lines to be shown in the short documentation overviews

expecially noticable for the slice primative type: https://doc.rust-lang.org/std/index.html

@rustbot
Copy link
Collaborator

rustbot commented Aug 30, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @workingjubilee (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Aug 30, 2024
@Urgau
Copy link
Member

Urgau commented Aug 30, 2024

there should probably be a lint against this in rustdoc

coincidentally such lint was just merged last week in Clippy: clippy::too_long_first_doc_paragraph

workingjubilee
workingjubilee reviewed Aug 31, 2024
View reviewed changes
Copy link
Member

@workingjubilee workingjubilee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! One nit.

@cjgillot cjgillot changed the title add extra linebreaks so rustdoc can identify the first sentance add extra linebreaks so rustdoc can identify the first sentence Aug 31, 2024
@lolbinarycat @workingjubilee
add extra linebreaks so rustdoc can identify the first sentence
0064bd1 
there should probably be a lint against this in rustdoc, it causes
too many lines to be shown in the short documentation overviews

expecially noticable for the slice primative type:
https://doc.rust-lang.org/std/index.html
@workingjubilee
Copy link
Member

just rebased, see 0 line diff if curious: https://github.com/rust-lang/rust/compare/18ea0c3a1f43d6d1a662224ee2f6d325791be30d..0064bd1b994b22093c6e7960818351ae65e0d183

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Sep 1, 2024

📌 Commit 0064bd1 has been approved by workingjubilee

It is now in the queue for this repository.

@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 Sep 1, 2024
@matthiaskrgr matthiaskrgr mentioned this pull request Sep 2, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@bors
Auto merge of rust-lang#129873 - matthiaskrgr:rollup-bv849ud, r=matth…
79cbc31 
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#127474 (doc: Make block of inline Deref methods foldable)
 - rust-lang#129678 (Deny imports of `rustc_type_ir::inherent` outside of type ir + new trait solver)
 - rust-lang#129738 (`rustc_mir_transform` cleanups)
 - rust-lang#129793 (add extra linebreaks so rustdoc can identify the first sentence)
 - rust-lang#129804 (Fixed some typos in the standard library documentation/comments)
 - rust-lang#129837 (Actually parse stdout json, instead of using hacky contains logic.)
 - rust-lang#129842 (Fix LLVM ABI NAME for riscv64imac-unknown-nuttx-elf)
 - rust-lang#129843 (Mark myself as on vacation for triagebot)
 - rust-lang#129858 (Replace walk with visit so we dont skip outermost expr kind in def collector)

Failed merges:

 - rust-lang#129777 (Add `unreachable_pub`, round 4)
 - rust-lang#129868 (Remove kobzol vacation status)

r? `@ghost`
`@rustbot` modify labels: rollup
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Sep 2, 2024
@workingjubilee
Rollup merge of rust-lang#129793 - lolbinarycat:doc-missing-newlines,…
3126ef7 
… r=workingjubilee

add extra linebreaks so rustdoc can identify the first sentence

there should probably be a lint against this in rustdoc, it causes too many lines to be shown in the short documentation overviews

expecially noticable for the slice primative type: https://doc.rust-lang.org/std/index.html
@workingjubilee workingjubilee mentioned this pull request Sep 2, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@bors
Auto merge of rust-lang#129873 - matthiaskrgr:rollup-bv849ud, r=matth…
57bad3f 
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#127474 (doc: Make block of inline Deref methods foldable)
 - rust-lang#129678 (Deny imports of `rustc_type_ir::inherent` outside of type ir + new trait solver)
 - rust-lang#129738 (`rustc_mir_transform` cleanups)
 - rust-lang#129793 (add extra linebreaks so rustdoc can identify the first sentence)
 - rust-lang#129804 (Fixed some typos in the standard library documentation/comments)
 - rust-lang#129837 (Actually parse stdout json, instead of using hacky contains logic.)
 - rust-lang#129842 (Fix LLVM ABI NAME for riscv64imac-unknown-nuttx-elf)
 - rust-lang#129843 (Mark myself as on vacation for triagebot)
 - rust-lang#129858 (Replace walk with visit so we dont skip outermost expr kind in def collector)

Failed merges:

 - rust-lang#129777 (Add `unreachable_pub`, round 4)
 - rust-lang#129868 (Remove kobzol vacation status)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@bors
Auto merge of rust-lang#129879 - workingjubilee:rollup-ke7mswr, r=wor…
752e43f 
…kingjubilee

Rollup of 11 pull requests

Successful merges:

 - rust-lang#127021 (Add target support for RTEMS Arm)
 - rust-lang#127474 (doc: Make block of inline Deref methods foldable)
 - rust-lang#129624 (Adjust `memchr` pinning and run `cargo update`)
 - rust-lang#129678 (Deny imports of `rustc_type_ir::inherent` outside of type ir + new trait solver)
 - rust-lang#129738 (`rustc_mir_transform` cleanups)
 - rust-lang#129793 (add extra linebreaks so rustdoc can identify the first sentence)
 - rust-lang#129804 (Fixed some typos in the standard library documentation/comments)
 - rust-lang#129837 (Actually parse stdout json, instead of using hacky contains logic.)
 - rust-lang#129842 (Fix LLVM ABI NAME for riscv64imac-unknown-nuttx-elf)
 - rust-lang#129843 (Mark myself as on vacation for triagebot)
 - rust-lang#129858 (Replace walk with visit so we dont skip outermost expr kind in def collector)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@bors
Auto merge of rust-lang#129873 - matthiaskrgr:rollup-bv849ud, r=matth…
b541676 
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#127474 (doc: Make block of inline Deref methods foldable)
 - rust-lang#129678 (Deny imports of `rustc_type_ir::inherent` outside of type ir + new trait solver)
 - rust-lang#129738 (`rustc_mir_transform` cleanups)
 - rust-lang#129793 (add extra linebreaks so rustdoc can identify the first sentence)
 - rust-lang#129804 (Fixed some typos in the standard library documentation/comments)
 - rust-lang#129837 (Actually parse stdout json, instead of using hacky contains logic.)
 - rust-lang#129842 (Fix LLVM ABI NAME for riscv64imac-unknown-nuttx-elf)
 - rust-lang#129843 (Mark myself as on vacation for triagebot)
 - rust-lang#129858 (Replace walk with visit so we dont skip outermost expr kind in def collector)

Failed merges:

 - rust-lang#129777 (Add `unreachable_pub`, round 4)
 - rust-lang#129868 (Remove kobzol vacation status)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@bors
Auto merge of rust-lang#129873 - matthiaskrgr:rollup-bv849ud, r=matth…
a460185 
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#127474 (doc: Make block of inline Deref methods foldable)
 - rust-lang#129678 (Deny imports of `rustc_type_ir::inherent` outside of type ir + new trait solver)
 - rust-lang#129738 (`rustc_mir_transform` cleanups)
 - rust-lang#129793 (add extra linebreaks so rustdoc can identify the first sentence)
 - rust-lang#129804 (Fixed some typos in the standard library documentation/comments)
 - rust-lang#129837 (Actually parse stdout json, instead of using hacky contains logic.)
 - rust-lang#129842 (Fix LLVM ABI NAME for riscv64imac-unknown-nuttx-elf)
 - rust-lang#129843 (Mark myself as on vacation for triagebot)
 - rust-lang#129858 (Replace walk with visit so we dont skip outermost expr kind in def collector)

Failed merges:

 - rust-lang#129777 (Add `unreachable_pub`, round 4)
 - rust-lang#129868 (Remove kobzol vacation status)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 8c28989 into rust-lang:master Sep 2, 2024
6 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Sep 2, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 2, 2024
@rust-timer
Unrolled build for rust-lang#129793
ca32bf5 
Rollup merge of rust-lang#129793 - lolbinarycat:doc-missing-newlines, r=workingjubilee

add extra linebreaks so rustdoc can identify the first sentence

there should probably be a lint against this in rustdoc, it causes too many lines to be shown in the short documentation overviews

expecially noticable for the slice primative type: https://doc.rust-lang.org/std/index.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@workingjubilee workingjubilee workingjubilee left review comments

Assignees

@workingjubilee workingjubilee

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.83.0
Development

Successfully merging this pull request may close these issues.
5 participants
@lolbinarycat @rustbot @Urgau @workingjubilee @bors