From: Felipe Contreras <felipe.contreras@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "SZEDER Gábor" <szeder@ira.uka.de>,
"Thomas Rast" <trast@student.ethz.ch>,
"Jonathan Nieder" <jrnieder@gmail.com>
Subject: Re: [PATCH v5] completion: add new __git_complete helper
Date: Wed, 16 May 2012 17:25:50 +0200 [thread overview]
Message-ID: <CAMP44s0F04HZc5+MJQrzDJ0qJNjogBSpnWPdiS9MRWrUZx4Bpg@mail.gmail.com> (raw)
In-Reply-To: <7v62bxfkeh.fsf@alter.siamese.dyndns.org>
On Tue, May 15, 2012 at 7:01 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Felipe Contreras <felipe.contreras@gmail.com> writes:
>> Is there something actionable?
>
> Like adding an explanation, preferrably a better one, there, so that the
> next person do not have to wonder and waste time like I did?
The next person that does what? Review the code while keeping an eye
on the way the variable arguments are used inside the implementation
of the function? I don't think there will *ever* be such a person
after the code is committed.
Either way, I believe in the notion of self-documenting code, so I
would rather add a few double quotes rather than add an essay on top
of the function just for you.
Not everything in the code needs to be documented, and most
documentation in the code is ignored anyway, and for a good example
take a look at the code in the Linux kernel.
Cheers.
--
Felipe Contreras
prev parent reply other threads:[~2012-05-16 15:25 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-05-14 15:35 [PATCH v5] completion: add new __git_complete helper Felipe Contreras
2012-05-14 14:38 ` Felipe Contreras
2012-05-14 17:43 ` Junio C Hamano
2012-05-14 17:55 ` Felipe Contreras
2012-05-14 18:13 ` Junio C Hamano
2012-05-14 18:30 ` Felipe Contreras
2012-05-14 19:09 ` Junio C Hamano
2012-05-14 19:53 ` Felipe Contreras
2012-05-15 17:01 ` Junio C Hamano
2012-05-15 17:03 ` Junio C Hamano
2012-05-16 15:25 ` Felipe Contreras [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=CAMP44s0F04HZc5+MJQrzDJ0qJNjogBSpnWPdiS9MRWrUZx4Bpg@mail.gmail.com \
--to=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=szeder@ira.uka.de \
--cc=trast@student.ethz.ch \
/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).