diff options
| author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-10 05:56:23 +0000 |
|---|---|---|
| committer | Marcel Amirault <mamirault@gitlab.com> | 2019-07-10 05:56:23 +0000 |
| commit | 2b03a0c2cf699074ec37a863e5c752a2cab2b133 (patch) | |
| tree | 7ebc289d2ec498fcebf8ae454cdb1eb1ef500dbd /doc/development/code_comments.md | |
| parent | c0deda7a86796c5de6ebe376c83f55af0965bde3 (diff) | |
| parent | 810df4fb51bf3db4016c5f7458599331d4586300 (diff) | |
| download | gitlab-ce-docs-hard-tabs.tar.gz | |
Merge branch 'master' into 'docs-hard-tabs'docs-hard-tabs
# Conflicts:
# doc/administration/pseudonymizer.md
# doc/administration/uploads.md
Diffstat (limited to 'doc/development/code_comments.md')
| -rw-r--r-- | doc/development/code_comments.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/code_comments.md b/doc/development/code_comments.md index 36962eb46d4..827a610efa2 100644 --- a/doc/development/code_comments.md +++ b/doc/development/code_comments.md @@ -1,11 +1,11 @@ # 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 +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 check if a comment is still relevant and what needs to be done to address it. -Examples: +Examples: ```rb # Deprecated scope until code_owner column has been migrated to rule_type. |