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.

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

Document how/when to use diagnostic items #1188

Closed
xFrednet opened this issue Aug 11, 2021 · 4 comments · Fixed by #1192
Closed

Document how/when to use diagnostic items #1188

xFrednet opened this issue Aug 11, 2021 · 4 comments · Fixed by #1192
Assignees

Comments

@xFrednet
Copy link
Member

Rustc has introduced diagnostic items to avoid using hard-coded paths to check for std and core types. However, there seems to be a lack of documentation regarding them. Here is a rough overview of what should be documented:

  • How to find the diagnostic item for type XYZ
  • How to add a new diagnostic item
    • Define diagnostic item naming conventions.
  • How to use diagnostic items

See rust-lang/rust-clippy#5393 for more context and related discussions/links etc.

@xFrednet
Copy link
Member Author

I'll start working on this. But it might take some time as I'm also busy with some RL stuff currently 🙃

@camelid
Copy link
Member

camelid commented Aug 18, 2021

Assigned you so that people know you're planning to work on it in the future :)

@xFrednet
Copy link
Member Author

Thank you!

@LeSeulArtichaut
Copy link
Contributor

(@rustbot claim is enabled in this repo as well, in case you would want to work on something else in the future 🙃)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants