Skip to content

fix(lint): Disable FIX002 to allow TODO comments #2926

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

Closed
wants to merge 1 commit into from

Conversation

esafak
Copy link
Contributor

@esafak esafak commented Aug 1, 2025

The linter was configured to flag all TODO comments, which can discourage developers from leaving them. This change disables the FIX002 rule in ruff to allow TODO comments without triggering a linting error.

  • ran the linter to address style issues (tox -e fix)
  • wrote descriptive pull request text
  • ensured there are test(s) validating the fix
  • added news fragment in docs/changelog folder
  • updated/extended the documentation

The linter was configured to flag all TODO comments, which can discourage developers from leaving them. This change disables the FIX002 rule in ruff to allow TODO comments without triggering a linting error.
Copy link
Contributor

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

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

Sorry, I'm not a fan of TODO comments, issues in our tracker are much better.

@gaborbernat gaborbernat closed this Aug 1, 2025
@esafak
Copy link
Contributor Author

esafak commented Aug 1, 2025

OK I won't leave them, but I won't open tickets for every little issue either!

@esafak esafak deleted the fix/disable-todo-linting branch August 1, 2025 23:17
@gaborbernat
Copy link
Contributor

That's fine, if something is not important, to do it right there and is not big enough to have an issue, it's likely a case of you ain't gonna need it. People don't tend to go back and clean up all this todo comments, so hence why I think they're a bit of a noise rather than value.

@esafak
Copy link
Contributor Author

esafak commented Aug 1, 2025

People don't tend to go and fix things full stop. We should only be concerned with people like me who are.

I hopefully fixed a flaky test in #2923 today simply because I came across it. It was not even a TODO, let alone an issue.

@gaborbernat
Copy link
Contributor

That's great and much appreciated. However, if you go and fix it, then there's no need for either to do or an issue.😁

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 this pull request may close these issues.

2 participants