Skip to content

Incorrect button names in pull request commenting instructions #45814

Description

@ashis-baral

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request#adding-comments-to-a-pull-request

What part(s) of the article would you like to see updated?

The instructions near the bottom of the article use an incorrect button name. The current text says:

If you only want to add this one comment, click Add single comment.

If you want to add multiple comments, click Start a review, then continue adding comments.

When you're finished, click Finish your review, leave a summary of your review, and click Submit review.

The instructions should be updated to:

If you only want to add this one comment, click Comment.

If you want to add multiple comments, click Start a review, then continue adding comments.

When you're finished, click Submit review, leave a summary of your review, and click Submit review.


Optionally, to suggest a specific change to the line or lines, click plus minus icon, then edit the text within the suggestion block.

The screenshot immediately below this instruction is outdated. It shows the old Add a single comment button, while the current GitHub UI shows Comment.

Additional information

The outdated screenshot and button labels can cause confusion for users following the documentation because they may look for Add a single comment, which is no longer the label shown in the current interface.

Updating the screenshot and the related instructions would make the article accurately reflect the current GitHub pull request review experience.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Waiting on contributorcontentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions