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

Check commented code, TODOs, and FIXMEs in the codebase #377

Closed
ghost opened this issue May 28, 2020 · 0 comments · Fixed by #998
Closed

Check commented code, TODOs, and FIXMEs in the codebase #377

ghost opened this issue May 28, 2020 · 0 comments · Fixed by #998
Labels
feature Adds functionality to the library
Milestone

Comments

@ghost
Copy link

ghost commented May 28, 2020

In the early days of the bindings, it was common to comment code out as a quick and dirty way to disable them. Some of them remained to this day, still broken in their original shape, and outdated compared to the rest of the codebase. TODOs and FIXMEs without issue numbers were also common. Some of these are already done, some others are not. We should look for them in the codebase and:

  • If a section of commented code is no longer relevant, remove it.
  • If a section of commented code is relevant, uncomment and fix it if possible. Otherwise, remove it and create an issue.
  • If a TODO or a FIXME is done or otherwise no longer applicable, just remove them. Otherwise, remove them and create an issue.
  • Establish that future TODO or FIXME comments must be accompanied with a GitHub issue number.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Adds functionality to the library
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants