Incorrect description regarding three-dot comparison in Pull Requests

[varlucian]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests#about-three-dot-comparison-on-github

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

The description of the three-dot comparison is actually the one for two-dot, and vice-versa.

Since the three-dot comparison compares with the merge base, it is focusing on "what a pull request introduces."

This is exactly what a two-dot comparison is about. And the Pull Requests show three-dot comparison and the sentence above is not accurate.

When you use a two-dot comparison, the diff changes when the base branch is updated, even if you haven't made any changes to the topic branch.

That is the description of the three-dot comparison.

Additional information

The error in the documentation is permanent.
I'd argue that the Pull Request should have implemented the two-dot comparison instead of three-dot.

Related discussion: https://github.com/orgs/community/discussions/147561

[welcome]

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