Enhancement of the explanation of the triple-dot syntax in 05 maintaining.asc

未关闭 适合新手
#516 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
68/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
git
领域
documentation

调研方向

打开 progit2/book/05-distributed-git/sections/maintaining.asc 的第 280 行附近，阅读其中关于 git diff 三点语法的相关说明。修改该句，使 branch 参数与三个点的顺序，以及与当前 branch 的显式比较，都不会产生歧义；确认示例与周围文本仍然一致。

由索引模型根据 Issue 内容生成。

描述

The sentence that describes the triple-dot syntax in 5.3 Maintaining a Project may be confusing

In the context of the diff command, you can put three periods after another branch to do a diff between 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

主要语言
CSS
星标
6.6k
派生
2.1k
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

progit/progit2 的其他 Issue

查看 progit/progit2 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。