diff options
author | James Ramsay <jramsay@gitlab.com> | 2019-04-17 17:39:38 +0300 |
---|---|---|
committer | James Ramsay <jramsay@gitlab.com> | 2019-04-17 17:39:38 +0300 |
commit | 6ad6cc40e0dca845ff26cd2f41f27c9c6f2792c7 (patch) | |
tree | e31c6968aaafd9fbc6ac95ddac4c5a741d999cd0 /doc/user/discussions | |
parent | 7f8cc85d9b422a1fd07bd4f274a512a5a574b40d (diff) |
Improve multi-line suggestion docs
Diffstat (limited to 'doc/user/discussions')
-rw-r--r-- | doc/user/discussions/index.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index bf41fdecd10..c7e8bb5b33b 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -348,19 +348,23 @@ Custom commit messages will be introduced by > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/53310) in GitLab 11.10. -Reviewers can also suggest changes to -multiple lines with a single suggestion within Merge Request diff discussions. +Reviewers can also suggest changes to multiple lines with a single suggestion +within Merge Request diff discussions by adjusting the range offsets. The +offsets are relative to the position of the diff discussion, and specify the +range to be replaced by the suggestion when it is applied. ![Multi-line suggestion syntax](img/multi-line-suggestion-syntax.png) -In the example above, the suggestion covers three lines above and four lines below the commented diff line. -It'd change from 3 lines _above_ to 4 lines _below_ the commented Diff line. +In the example above, the suggestion covers three lines above and four lines +below the commented line. When applied, it would replace from 3 lines _above_ +to 4 lines _below_ the commented line, with the suggested change. ![Multi-line suggestion preview](img/multi-line-suggestion-preview.png) NOTE: **Note:** -Suggestions covering multiple lines are limited to 100 lines _above_ and 100 lines _below_ -the commented diff line, allowing up to 200 changed lines per suggestion. +Suggestions covering multiple lines are limited to 100 lines _above_ and 100 +lines _below_ the commented diff line, allowing up to 200 changed lines per +suggestion. ## Start a discussion by replying to a standard comment |