edx-documentation
edx-documentation copied to clipboard
Guideline about "TODO" is ambiguous
See https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html#pylint-guidelines-and-practices:
Adding a TODO in one place requires you to make a pylint fix in another (just to force us to clean up more code).
Please state explicitly whether "TODO" or "FIXME" is discourage and offer a viable alternative for flagging technical debt in the codebase when it cannot be addressed immediately due to time and scope constraints.