-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Collect renamed lints #8843
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
Collect renamed lints #8843
Conversation
2a383ae
to
3045d53
Compare
Have you thought about how we want to display the renamed lint name on the website? I was considering something like this: Or maybe (Though I like the first option more) In either case, we can prepare do some work in our metadata collector to make the website faster. That's why I'm asking 🙃 r? @dswij You might want to wait until we're resolved the presentation part. You're welcome to also share your ideas 🙃 |
I had a similar idea to the first one, except it was "Past names" instead of "Notes". Since it'll show up in search regardless, I don't think making a new entry to point to the rename is necessary. 🙂 |
Past names is a better name. In that case, I would already add this to the documentation in rust, similar to how it's done for configurations. 🙃 |
Was just thinking if What happens when we rename a lint twice? Would |
3045d53
to
02283c2
Compare
I updated it to account for multiple renames 🙂. |
Nice, this still leaves the question where these will be rendered. I'm still for adding it to the lint description like it's done for the configuration 🙃 |
Yeah, I think it should go under the configuration as a bulleted list. |
What I meant with my question of where this will be rendered was, where in our tech-stack. So if this will append the section in the metadata collector (Like the configuration section) or on the website. Where possible, I usually prefer adding it during the collection in rust, since any logic on Clippy's lint list is multiplied by the number of lints and delays the rendering. That's also why I'm mentioning this here and not in the related frontend PR since, we can implement this without touching the frontend. 🙃 Sorry, if that was unclear 😅 |
Oh 😄. In that case, yeah it should definitely be added like the configuration. I'll get that done soon. |
2cec2ad
to
0db5e6b
Compare
0db5e6b
to
45be175
Compare
The example looks good IMO 👍 |
The |
Sure, go ahead! |
Excellent work! I've also tested it locally and everything works perfectly. Thank you very much for this update. I'm happy to see the metadata collection project to make progress and with your work probably also be completed! ❤️ This was my first big project in Clippy, and it's also the one that held me here and introduced me to the team. I hope you also had fun with it. Now enough rambling: @bors r+ |
📌 Commit 45be175 has been approved by |
Collect renamed lints changelog: none cc #7172 r? `@xFrednet`
@bors r- |
Sorry for the r-, this is worth a changelog entry. I don't want this to slip under the radar of who ever will write it for that version. I've added the entry and also ticked of the checkbox in the tracking issue @bors r+ |
📌 Commit 45be175 has been approved by |
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
changelog: Display past names of renamed lints on Clippy's lint list
cc #7172
r? @xFrednet