Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:1
-
Epic Link:
-
Sprint:Alert Production S17 - 3
-
Team:Alert Production
Description
Following discussion on RFC-307, this ticket adds the following rule to the Python style guide:
To-do comments SHOULD include a Jira issue key
If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.
# TODO: DM-12345 is triggered by this line
|
# TODO: workaround for DM-6789
|
and the following rule to the C++ style guide:
6-26. To-do comments SHOULD include a Jira issue key
If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.
// TODO: DM-12345 is triggered by this line
|
// TODO: workaround for DM-6789
|
Attachments
Issue Links
- is triggered by
-
RFC-307 Discourage use of @todo Doxygen tag
- Implemented