Skip to content

fix code blocks in doc comments inconsistently using 3 or 4 spaces of indentation#13261

Merged
bors merged 1 commit intorust-lang:masterfrom
antonilol:fix-doc-code-blocks
Aug 12, 2024
Merged

fix code blocks in doc comments inconsistently using 3 or 4 spaces of indentation#13261
bors merged 1 commit intorust-lang:masterfrom
antonilol:fix-doc-code-blocks

Conversation

@antonilol
Copy link
Contributor

@antonilol antonilol commented Aug 12, 2024 •
edited by xFrednet
Loading

The metadata collector script was treating the space lines all start with as indentation. This caused code block's triple backticks to get a space in front of it, like this:

 ```rust
^ this space

Code after that that is indented with 4 spaces will only have 3 of those rendered.
Example (taken from here):

...
pub fn divide_by(x: i32, y: i32) -> i32 {
   if y == 0 {                      // 3 spaces
       panic!("Cannot divide by 0") // 7 spaces
...

Also added 'compile_fail' alongside the other rustdoc directives (second code block here had no highlighting), fixed a doc comment using 'rs' instead of 'rust' and removed some spaces causing an extra missing space of indentation (see second code block here).

changelog: none

@rustbot
Copy link
Collaborator

rustbot commented Aug 12, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Centri3 (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 the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 12, 2024
xFrednet
xFrednet approved these changes Aug 12, 2024
View reviewed changes
Copy link
Contributor

@xFrednet xFrednet left a comment

Choose a reason for hiding this comment

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

r? @xFrednet

@rustbot rustbot assigned xFrednet and unassigned Centri3 Aug 12, 2024
@xFrednet
Copy link
Contributor

xFrednet commented Aug 12, 2024

Nice catch, thank you for the PR :D

cc: @Alexendoo this adds a slight modification to the metadata collector. You'll likely have to rebase your PR and copy the changes as well #13221

Roses are red,
•Violets are blue,
••Spaces are added,
•••Indention is cool,

@bors
Copy link
Contributor

bors commented Aug 12, 2024

📌 Commit d7f1252 has been approved by xFrednet

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Aug 12, 2024

⌛ Testing commit d7f1252 with merge e070784...

@xFrednet xFrednet mentioned this pull request Aug 12, 2024
Merged
@bors
Copy link
Contributor

bors commented Aug 12, 2024

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: xFrednet
Pushing e070784 to master...

@bors bors merged commit e070784 into rust-lang:master Aug 12, 2024
@bors bors mentioned this pull request Aug 12, 2024
Merged
@antonilol antonilol deleted the fix-doc-code-blocks branch August 12, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@xFrednet xFrednet xFrednet approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@xFrednet xFrednet

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@antonilol @rustbot @xFrednet @bors @Centri3