git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Elia Pinto <gitter.spiros@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] git-reflog.txt: add an EXAMPLES section
Date: Mon, 03 Oct 2022 09:36:18 -0700	[thread overview]
Message-ID: <xmqq4jwkx3st.fsf@gitster.g> (raw)
In-Reply-To: <da2c8d2f-eefa-1681-b1f2-93c7865c300c@gmail.com> (Bagas Sanjaya's message of "Mon, 3 Oct 2022 20:07:33 +0700")

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On 10/3/22 15:46, Elia Pinto wrote:
>> This commit adds an "EXAMPLES" section to the git reflog man page.
>> This new section currently provides examples of using git reflog
>> with branches, for which doubts often exist. In this commit we also
>> add a "SEE ALSO" section which refers to further information
>> on git commands or documentation referenced in the git reflog man page.
>> 
>
> Better say "Add git-reflog usage examples to the man page."

Thanks, indeed.

> Also, shouldn't "SEE ALSO" additions be split from this patch?

I think they are better together.  The overall theme is to help
readers of that one documentation page, and 80% of the effort of
this step is spent on adding an EXAMPLES section, while the rest
goes to SEE ALSO.

Thanks.

      reply	other threads:[~2022-10-03 16:36 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-03  8:46 [PATCH] git-reflog.txt: add an EXAMPLES section Elia Pinto
2022-10-03  9:20 ` Ævar Arnfjörð Bjarmason
2022-10-03 13:53   ` Elia Pinto
2022-10-03 16:40     ` Junio C Hamano
2022-10-03 16:31   ` Junio C Hamano
2022-10-03 13:07 ` Bagas Sanjaya
2022-10-03 16:36   ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq4jwkx3st.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitter.spiros@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).