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

オープン 初心者向け
#516 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

progit/progit2 のほかの issue

progit/progit2 の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。