git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v5] completion: add new __git_complete helper

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 16, 2012, 15:25 UTC
Message-ID
<CAMP44s0F04HZc5+MJQrzDJ0qJNjogBSpnWPdiS9MRWrUZx4Bpg@mail.gmail.com>
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
Previous: Junio C Hamano
Message 11 of 11 in “completion: add new __git_complete helper”
  1. completion: add new __git_complete helperFelipe Contreras, May 14, 2012
  2. Felipe ContrerasMay 14, 2012
  3. Junio C HamanoMay 14, 2012
  4. Felipe ContrerasMay 14, 2012
  5. Junio C HamanoMay 14, 2012
  6. Felipe ContrerasMay 14, 2012
  7. Junio C HamanoMay 14, 2012
  8. Felipe ContrerasMay 14, 2012
  9. Junio C HamanoMay 15, 2012
  10. Junio C HamanoMay 15, 2012
  11. Felipe ContrerasMay 16, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.