docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify the method of selecting several lines for commenting in PR.

Open Denis-GH opened this issue 1 year ago • 4 comments

Why:

When I read this, I didn't understand where I needed to click to add a comment to multiple lines. So I suggest clarifying this.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Instead of just "click and drag" you should say where to click: "click on a line in the line number gutter area". In addition, there is another way to add a comment to several lines: "click on the blue comment icon and drag to select the range of lines".

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

Denis-GH avatar May 16 '24 18:05 Denis-GH

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar May 16 '24 18:05 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar May 16 '24 18:05 github-actions[bot]

@Denis-GH Thanks so much for opening a PR! I'll get this triaged for review ✨

nguyenalex836 avatar May 16 '24 19:05 nguyenalex836

@subatoi Thak you for reply! I have made the changes as per your suggestion. I have also added this to another doc about this.

Denis-GH avatar May 18 '24 05:05 Denis-GH

I'll go ahead and merge this shortly :)

subatoi avatar May 20 '24 14:05 subatoi

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar May 20 '24 21:05 github-actions[bot]