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

Meta-TODO: Associate in-comment TODOs with Issues #672

Open
alxmrs opened this issue Jan 15, 2025 · 2 comments
Open

Meta-TODO: Associate in-comment TODOs with Issues #672

alxmrs opened this issue Jan 15, 2025 · 2 comments

Comments

@alxmrs
Copy link
Contributor

alxmrs commented Jan 15, 2025

# TODO: check arrays all have same shape

A pattern for tracking work I really enjoy is associating TODOs in code with github issues. Even if these are the lowest priority, it's still nice to associate code with some issue tracker.

The above line could look like:

TODO(#XXX): check arrays all have same shape 

for example.

@TomNicholas
Copy link
Member

I agree - I find a TODO without an issue gets completely forgotten about because it's invisible unless you happen to be looking at that exact spot in the codebase already.

@tomwhite
Copy link
Member

I like this suggestion.

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

No branches or pull requests

3 participants