diff options
Diffstat (limited to 'doc/development/code_comments.md')
| -rw-r--r-- | doc/development/code_comments.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/development/code_comments.md b/doc/development/code_comments.md index d9ab719d18a..b1db781b9ee 100644 --- a/doc/development/code_comments.md +++ b/doc/development/code_comments.md @@ -1,14 +1,14 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Code comments Whenever you add comment to the code that is expected to be addressed at any time in future, please create a technical debt issue for it. Then put a link to it -to the code comment you've created. This will allow other developers to quickly +to the code comment you've created. This allows other developers to quickly check if a comment is still relevant and what needs to be done to address it. Examples: |