Skip to content

Fix display of configs in clippy doc page #13166

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.

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

Merged
merged 1 commit into from
Jul 28, 2024

Conversation

GuillaumeGomez
Copy link
Member

Fixes #13051.

It was simply some empty lines missing between configs. With this fix it looks like expected:

image

r? @xFrednet

changelog: Fix display of configs in clippy doc page

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Jul 26, 2024
@xFrednet
Copy link
Member

The default and example were intended to be on the same indention level as the rest of the documentation. I'm guessing that reindenting the docs would be the proper fix. Maybe we can use reindent_multiline?

@flip1995
Copy link
Member

Only inserting 1 \n should also keep the indentation.

@GuillaumeGomez
Copy link
Member Author

The indentation is same. The only difference is that it's a list, so we're inside the list's indentation.

Only inserting 1 \n should also keep the indentation.

Better safe than sorry.

@xFrednet
Copy link
Member

I've checked out the branch, and the elements are not in the same <ul> element in the parsed markdown. I tried to get it working by changing the indention, but I couldn't find a thing that works (After like 5 min). Here is what I mean:

image

The "Noteworthy" should also be under the bullet point, but the code block just seems to break it -.-

Maybe we can get it fixed by adding the <ul></ul> html elements in the metadata collection?

IDK. While I like this to be fixed, we can also leave it as an open todo, since this already improves the display. So you can r=me if you want to leave it at this @GuillaumeGomez


Roses are red,
this fix can help,
it can be r=med,
as it's now delegated...?

(The poem quality is somehow still degrading)

@bors
Copy link
Contributor

bors commented Jul 27, 2024

✌️ @GuillaumeGomez, you can now approve this pull request!

If @xFrednet told you to "r=me" after making some further change, please make that change, then do @bors r=@xFrednet

@GuillaumeGomez
Copy link
Member Author

First let's fix the biggest problem. I'll do a follow-up to have everything included in the <li> element.

@bors r=xFrednet

@bors
Copy link
Contributor

bors commented Jul 28, 2024

📌 Commit b5fa6e2 has been approved by xFrednet

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Jul 28, 2024

⌛ Testing commit b5fa6e2 with merge 668b659...

@bors
Copy link
Contributor

bors commented Jul 28, 2024

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

@bors bors merged commit 668b659 into rust-lang:master Jul 28, 2024
8 checks passed
@GuillaumeGomez GuillaumeGomez deleted the fix-clippy-doc branch July 28, 2024 09:27
bors added a commit that referenced this pull request Jul 31, 2024
…=xFrednet

Fix broken list for lints config

Follow-up of #13166.

Finally figured out that it was a transformation and not the source that was the problem. It now looks like this:

![Screenshot from 2024-07-29 16-29-10](https://github.com/user-attachments/assets/4b89b3fe-8f85-47b8-8d9a-505badeaeac4)

r? `@xFrednet`

changelog: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc broken on the website for arithmetic_side_effects
5 participants