Enhancement of the explanation of the triple-dot syntax in 05 maintaining.asc
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- git
- Domain
- documentation
Research direction
Open progit2/book/05-distributed-git/sections/maintaining.asc around line 280 and read the surrounding explanation of git diff's triple-dot syntax. Revise the sentence so the order of the branch argument and three dots, and the explicit current-branch comparison, are unambiguous; confirm the example and surrounding text still agree.
Written by the indexing model from the issue text.
Description
The sentence that describes the triple-dot syntax in 5.3 Maintaining a Project may be confusing
In the context of the
diffcommand, you can put three periods after another branch to do adiffbetween the last commit of the branch you're on and its common ancestor with another branch:
$ git diff master...contrib
The command example makes it clear. Also the contrib is mentioned earlier in the text as the topic branch.
English is not my first language, so it could look more confusing to me. The "another branch" slightly does not suggest that it should be written before the three dots (my point of view). Also, "the last commit of the branch you're on" suggests that the current branch could be an implicit argument -- and it is not.
The sentence is located in
progit2/book/05-distributed-git/sections/maintaining.asc
line 280
Regards,
Petr
- Dominant language
- CSS
- Stars
- 6.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from progit/progit2
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 62/100
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100