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

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 3, 2017, 05:35 UTC
Message-ID: <xmqqindojrw1.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20171130030727.GA24732@sigill.intra.peff.net>

Jeff King <peff@peff.net> 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 such a commented out code to make sure it is up to date.

> I'm all for code examples in documentation, but this one is quite
> complex. The code in test-hashmap.c is not much more complex, and is at
> least guaranteed to compile and run.

Yup.  Exactly.

> It doesn't show off how to combine a flex-array with a hashmap as
> well, but I'm not sure how important that is. So I could go either
> way.

Likewise.

In any case, keeping a bad example as-is is less good than replacing it with a corrected one, so I do not mind taking this patch as an immediate first step, whether we later decide to remove it and refer to an external file that has a real example that will be easier to maintain and use.

Thanks.