search

probabilistic-numerics / probnum

Probabilistic Numerics in Python.
http://probnum.org
MIT License
438 stars 57 forks source link

Best practice for `# TODO` comments #198

Open marvinpfoertner opened 4 years ago

marvinpfoertner commented 4 years ago

As discussed with @JonathanWenger, we should allow # TODO comments in the codebase, but only in a well-defined format. I propose to only allow them if they are formatted as # TODO: (#1234) Description of what needs to be done, where #1234 is a GitHub issue number. This should also be added to the project documentation.

marvinpfoertner commented 4 years ago

Any thoughts? @JonathanWenger @pnkraemer @nathanaelbosch

nathanaelbosch commented 4 years ago

Sounds good to me! I still think they can and should be avoided in many cases, but for the cases where they are useful they should definitely follow some well-defined format. I think the idea with the GitHub issue number is really good :)

pnkraemer commented 4 years ago

I agree wholeheartedly with @nathanaelbosch ;)