Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-12-08 Thread Jeff King
On Thu, Dec 07, 2017 at 10:47:43PM +0100, Johannes Schindelin wrote: > > We could add that example to the test helper as then we have a good (tested) > > example for that case, too. > > What we could *also* do, and what would probably make *even more* sense, > is to simplify the example drastical

Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-12-07 Thread Johannes Schindelin
Hi, On Mon, 4 Dec 2017, Stefan Beller wrote: > On Sat, Dec 2, 2017 at 9:35 PM, Junio C Hamano wrote: > > Jeff King writes: > > > >> My second suggestion (which I'm on the fence about) is: would it better > >> to just say "see t/helper/test-hashmap.c for a representative example?" > > I think t

Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-12-04 Thread Stefan Beller
On Sat, Dec 2, 2017 at 9:35 PM, Junio C Hamano wrote: > Jeff King writes: > >> My second suggestion (which I'm on the fence about) is: would it better >> to just say "see t/helper/test-hashmap.c for a representative example?" I think that may be better in the long run, indeed. > > I also had th

Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-12-02 Thread Junio C Hamano
Jeff King writes: > My second suggestion (which I'm on the fence about) is: would it better > to just say "see t/helper/test-hashmap.c for a representative example?" I also had the same thought. It is rather unwieldy to ask people to lift code from comment text, and it is also hard to maintain

Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-11-29 Thread Jeff King
On Thu, Nov 30, 2017 at 12:51:41AM +0100, Johannes Schindelin wrote: > The hashmap API is just complicated enough that even at least one > long-time Git contributor has to look up how to use it every time he > finds a new use case. When that happens, it is really useful if the > provided example c

Re: [PATCH] hashmap: adjust documentation to reflect reality

2017-11-29 Thread Jonathan Nieder
Johannes Schindelin wrote: > The hashmap API is just complicated enough that even at least one > long-time Git contributor has to look up how to use it every time he > finds a new use case. When that happens, it is really useful if the > provided example code is correct... > > While at it, "fix a

[PATCH] hashmap: adjust documentation to reflect reality

2017-11-29 Thread Johannes Schindelin
The hashmap API is just complicated enough that even at least one long-time Git contributor has to look up how to use it every time he finds a new use case. When that happens, it is really useful if the provided example code is correct... While at it, "fix a memory leak", avoid statements before v