Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
May 20, 2024

Conversation

Denis-GH
Copy link
Contributor

@Denis-GH Denis-GH commented May 16, 2024

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:

  • 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.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented May 16, 2024

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 16, 2024
Copy link
Contributor

github-actions bot commented May 16, 2024

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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review pull requests Content related to pull requests and removed triage Do not begin working on this issue until triaged by the team labels May 16, 2024
@nguyenalex836
Copy link
Contributor

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

Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Denis-GH, we appreciate you taking the time to raise a PR. Generally, we'd kindly ask if you could open an issue first in future, just so we can agree on an approach before going ahead with a solution.

In this case, I'm not confident all users will know what "gutter area" means, and it probably wouldn't be translated correctly. We can also take the opportunity to use an octicon here ({% octicon "plus" aria-label="The plus sign icon" %}) so I'd suggest this alternative solution:

  1. Remove all the text after "To add a comment on multiple lines..." in the numbered list item in question.

  2. Add a new numbered list item as follows:

  1. Optionally, you can add a comment on multiple lines. You can click the line number of the first line you want to comment on and drag down to select a range of lines, then click {% octicon "plus" aria-label="The plus sign icon" %} on the last line you want to comment on. Alternatively, you can click {% octicon "plus" aria-label="The plus sign icon" %} next to the first line you want to comment on, then drag down to the last line you want to comment on.

If you're happy to make those changes, then I'm happy to approve this and get it merged.

@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review and removed waiting for review Issue/PR is waiting for a writer's review labels May 17, 2024
@Denis-GH
Copy link
Contributor Author

Denis-GH commented May 18, 2024

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

subatoi
subatoi previously approved these changes May 20, 2024
Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks @Denis-GH, and thank you for thinking about this so carefully with the reusables!

I have to apologise as I'm going to contradict something I said earlier, but I've realised we don't use an octicon for the same icon elsewhere in this same document, and instead we just refer to the "blue comment icon". For the sake of consistency, I've made a suggestion to change this back.

As soon as we're happy with that last point, I'll go ahead and merge this 👍

data/reusables/repositories/multiple-lines-comment.md Outdated Show resolved Hide resolved
@subatoi
Copy link
Contributor

subatoi commented May 20, 2024

I'll go ahead and merge this shortly :)

@nguyenalex836 nguyenalex836 added this pull request to the merge queue May 20, 2024
Merged via the queue into github:main with commit 90ca828 May 20, 2024
44 checks passed
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review pull requests Content related to pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants