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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, May 15, 2012 at 7:01 PM, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> Felipe Contreras <felipe.contreras@xxxxxxxxx> 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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]