diff options
| author | Nasser Grainawi <nasser.grainawi@linaro.org> | 2024-02-12 13:57:01 -0700 |
|---|---|---|
| committer | Nasser Grainawi <nasser.grainawi@linaro.org> | 2024-02-12 15:20:00 -0700 |
| commit | e42e5c7f4bfd6e9999844bf4206c156d3bcfec53 (patch) | |
| tree | 726e00669322247b8ce7fe22472e7b3079f7b32a | |
| parent | 7fd306b230daf6c27a3afc8262b6f725cffde9cc (diff) | |
docs: Improve wording for suggested edits
The doc was a bit challenging to read. Improve the linking, consistently
use the term 'suggested edit', and fix some other nits.
Change-Id: I7086314c250b4528970925aef594d852db770f18
Release-Notes: docs
| -rw-r--r-- | Documentation/user-suggest-edits.txt | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/user-suggest-edits.txt b/Documentation/user-suggest-edits.txt index abc64c833e..fa49eeb7e9 100644 --- a/Documentation/user-suggest-edits.txt +++ b/Documentation/user-suggest-edits.txt @@ -1,7 +1,7 @@ = Gerrit Code Review - User suggested edits Easy and fast way for reviewers to suggest code changes that can be easily applied -by change owner. +by the change owner. == Reviewer workflow @@ -26,15 +26,16 @@ image::images/user-suggest-edits-preview.png["Suggestion Preview", align="center == Author workflow -You can apply one or more suggested fixes. When suggested fix is applied - it creates -a change edit that you can modify in gerrit. link:user-inline-edit.html#editing-change[More about editing mode.] +You can apply one or more suggested edits. When a suggested edit is applied it +creates a change edit that you can further modify in Gerrit. You can read more +about all the features of link:user-inline-edit.html#editing-change[change edit mode]. -FYI: Publishing a new patchset in gerrit will make gerrit change out of sync with -your local git. You can checkout latest gerrit by using commands from download drop-down panel. -link:user-review-ui.html#download[More about download drop-down panel] +FYI: Publishing a new patchset in Gerrit will make your Gerrit change out of +sync with your local git commit. You can checkout the latest Gerrit patchset +by using the commands from the link:user-review-ui.html#download[download drop-down panel]. -You can use copy to clipboard button to copy suggestion to clipboard and then you can paste it -in your editor. +Alternatively, you can use the copy to clipboard button to copy a suggested +edit to your clipboard and then you can paste it into your editor. GERRIT ------ |