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

[pyOpenSci review] improve TODOs and FIXMEs with additional context #537

Closed
rich-iannone opened this issue Dec 2, 2024 · 1 comment
Closed

Comments

@rich-iannone
Copy link
Member

From the pyOpenSci comment:

suggestion (general): great-tables' code base is massive, so it's not a surprise that there is a lot going on, maintenance-wise. I'd like to share a tip I've used for a few years to manage my TODOs and FIXMEs throughout code bases. I use the syntax # (): (FIXME, respectively)(you may notice that it's the same "conventional" syntax that I use in this very same review). The idea is that you can quickly extract all the TODOs related to a specific subject. For instance, in _utils.py, in the pairwise function, the comment about Python 3.10 could be # TODO(py310): Remove because part of stdlib. With this one trick, you can easily track down all TODOs and FIXMEs related to Python 3.10.

pyOpenSci/software-submission#202 (comment)

@machow
Copy link
Collaborator

machow commented Dec 12, 2024

We plan to circle back to this, and have noted it, but I'm going to close here for now.

@machow machow closed this as not planned Won't fix, can't repro, duplicate, stale Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants