XMLWordPrintable

#### Details

• Type: Improvement
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
• Story Points:
1
• Sprint:
• Team:

#### 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 

#### Activity

Hide
Krzysztof Findeisen added a comment -

Hi Kian-Tat Lim, could you please review DM-7892 and DM-9966? These are the final changes to the dev guide needed to close RFC-225 and RFC-307, and they're fairly small updates.

Show
Krzysztof Findeisen added a comment - Hi Kian-Tat Lim , could you please review DM-7892 and DM-9966 ? These are the final changes to the dev guide needed to close RFC-225 and RFC-307 , and they're fairly small updates.
Hide
Kian-Tat Lim added a comment -

LGTM. Ship it!

Show
Kian-Tat Lim added a comment - LGTM. Ship it!

#### People

Assignee:
Krzysztof Findeisen
Reporter:
Krzysztof Findeisen
Reviewers:
Kian-Tat Lim
Watchers:
Jim Bosch, Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen