Skip to content
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

Fixing rustDoc for LayoutError. #131512

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Fixing rustDoc for LayoutError. #131512

merged 1 commit into from
Oct 11, 2024
+2 −1

Conversation

j7nw4r
Copy link
Contributor

@j7nw4r j7nw4r commented Oct 10, 2024

I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.

@rustbot
Copy link
Collaborator

rustbot commented Oct 10, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @jhpratt (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 Oct 10, 2024
@clubby789 clubby789 added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Oct 10, 2024
@jhpratt
Copy link
Member

jhpratt commented Oct 11, 2024

For consistency purposes I wanted to check that this isn't out of the ordinary, as the existing documentation is correct. Many other errors in the standard library provide similar context, so this LGTM.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 11, 2024

📌 Commit 8b754fb has been approved by jhpratt

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 Oct 11, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 11, 2024
@bors
Auto merge of rust-lang#131512 - j7nw4r:master, r=jhpratt
44adce9 
Fixing rustDoc for LayoutError.

I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.
@bors
Copy link
Contributor

bors commented Oct 11, 2024

⌛ Testing commit 8b754fb with merge 44adce9...

@rust-log-analyzer
Copy link
Collaborator

The job x86_64-msvc-ext failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

@bors
Copy link
Contributor

bors commented Oct 11, 2024

💔 Test failed - checks-actions

@bors bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 11, 2024
@jhpratt
Copy link
Member

jhpratt commented Oct 11, 2024

@bors retry

@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 Oct 11, 2024
Zalathar added a commit to Zalathar/rust that referenced this pull request Oct 11, 2024
@Zalathar
Rollup merge of rust-lang#131512 - j7nw4r:master, r=jhpratt
4e91dd2 
Fixing rustDoc for LayoutError.

I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.
@Zalathar Zalathar mentioned this pull request Oct 11, 2024
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 11, 2024
@matthiaskrgr
Rollup merge of rust-lang#131512 - j7nw4r:master, r=jhpratt
9341dfd 
Fixing rustDoc for LayoutError.

I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 11, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 11, 2024
@bors
Auto merge of rust-lang#131539 - matthiaskrgr:rollup-lxbdzlf, r=matth…
90b7dbb 
…iaskrgr

Rollup of 5 pull requests

Successful merges:

 - rust-lang#131464 (Update wasm-component-ld to 0.5.10)
 - rust-lang#131498 (Consider outermost const-anon in `non_local_def` lint)
 - rust-lang#131512 (Fixing rustDoc for LayoutError.)
 - rust-lang#131529 (rustdoc-json-types: fix typo in comment)
 - rust-lang#131531 (move dummy commit logic into x86_64-gnu-llvm-18)

Failed merges:

 - rust-lang#131476 (coverage: Include the highest counter ID seen in `.cov-map` dumps)

r? `@ghost`
`@rustbot` modify labels: rollup
@matthiaskrgr matthiaskrgr mentioned this pull request Oct 11, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 11, 2024
@bors
Auto merge of rust-lang#131540 - matthiaskrgr:rollup-elbgu1w, r=matth…
484c8e7 
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#131464 (Update wasm-component-ld to 0.5.10)
 - rust-lang#131476 (coverage: Include the highest counter ID seen in `.cov-map` dumps)
 - rust-lang#131497 (Add myself to bootstrap review rotation)
 - rust-lang#131498 (Consider outermost const-anon in `non_local_def` lint)
 - rust-lang#131512 (Fixing rustDoc for LayoutError.)
 - rust-lang#131529 (rustdoc-json-types: fix typo in comment)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit cac3628 into rust-lang:master Oct 11, 2024
6 of 7 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Oct 11, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 11, 2024
@rust-timer
Unrolled build for rust-lang#131512
cb7d5b3 
Rollup merge of rust-lang#131512 - j7nw4r:master, r=jhpratt

Fixing rustDoc for LayoutError.

I started reading the the std lib from start to finish and noticed that this rustdoc comment wasn't correct.
@tgross35
Copy link
Contributor

@bors r- still in the queue

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 11, 2024
@j7nw4r
Copy link
Contributor Author

j7nw4r commented Oct 12, 2024 •
edited
Loading

Is there something that I need to do? I see the tag says waiting on author.

@jhpratt
Copy link
Member

jhpratt commented Oct 12, 2024

Nope! The PR has been merged. The label is a side effect of the bot acting up and trying to merge it twice.

@jhpratt jhpratt added merged-by-bors This PR was explicitly merged by bors. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 12, 2024
@j7nw4r
Copy link
Contributor Author

j7nw4r commented Oct 12, 2024

Ah ok. Thanks a lot. This is my first commit to the rust language. I guess I'm just a little eager.

@jhpratt
Copy link
Member

jhpratt commented Oct 12, 2024

No worries! You can actually see the change if you view the docs on nightly.

https://doc.rust-lang.org/nightly/std/alloc/struct.LayoutError.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jhpratt jhpratt

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools merged-by-bors This PR was explicitly merged by bors. 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.
7 participants
@j7nw4r @rustbot @jhpratt @bors @rust-log-analyzer @tgross35 @clubby789