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

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

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

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:53:50

Felipe Contreras [off-list ref] writes:
On Mon, May 14, 2012 at 9:09 PM, Junio C Hamano [off-list ref] wrote:
quoted
Felipe Contreras [off-list ref] writes:
quoted
quoted
Here is my attempt to explain why none of them needs to be quoted:
...
I don't understand that.
That was my attempt to give the readers some context to understand what
comes after that....
I mean I don't understand this "Note that none of the variable
reference in the implementation of this function needs dq around it."
You later say "then yeah, I agree.", so I am interpreting this "I don't
understand" to mean that you do agree that missing dq around $1, $2 and
$wrapper in the function is _not_ a problem, and you do not understand why
it needs to be explained.  See below.
I suppose you meant 'references' (as that would make it grammatically
correct AFAICS),...
Correct.
but I still don't understand what you are trying so
say. That the way the arguments are used in the __git_complete
function makes it so double quotes are irrelevant?
Correct.
If so, then yeah, I agree.

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?

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

From: Felipe Contreras <hidden>
Date: 2016-06-15 22:53:50

On Tue, May 15, 2012 at 7:01 PM, Junio C Hamano [off-list ref] wrote:
Felipe Contreras [off-list ref] writes:
quoted
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help