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

[red-knot] Document all lints #14889

Open
MichaReiser opened this issue Dec 10, 2024 · 2 comments
Open

[red-knot] Document all lints #14889

MichaReiser opened this issue Dec 10, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference

Comments

@MichaReiser
Copy link
Member

With #14873, it's now required to document every lint. The PR itself documented some lints but not all of them.

The goal of this issue is to go through all lints and add documentation to them, similar to what we have in ruff.
@MichaReiser MichaReiser added documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference labels Dec 10, 2024
@InSyncWithFoo
Copy link
Contributor

Is this help-wanted? There are currently 21 rules with /// TODO #14889; that should only take up one of my afternoons or so.

@MichaReiser
Copy link
Member Author

Thanks for asking. IMO, it has fairly low priority at the moment and we don't even know if we'll keep the rules as they are right now. That's why I probably would wait.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation red-knot Multi-file analysis & type inference
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MichaReiser @InSyncWithFoo