Jonathan Nieder <jrnie...@gmail.com> writes: > Johannes Schindelin wrote: >> On Tue, 19 Sep 2017, Jonathan Nieder wrote: > >>> Could this example go near the top of the header instead? That way, >>> it's easier for people reading the header to see how to use it. >> >> Funny, I am *so* used to examples being at the very end, from tutorials to >> man pages. >> >> If my experience is any indication, I would rather keep this order. > > Sorry for the lack of clarity. I meant "near the top of the header > *file*".
Yeah, I think it would help to have something like that near the top of the header file for the potential users of the helper. > FWIW nothing I noticed came to the level of requiring a v2 imho. If any > of the ideas I mentioned seems good, they can go in patches on top. True, too, and additional "doc in header" can also be done as a follow-up. But as I heard "v2 in a few days", I'll throw it in the "Expecting a reroll" bin for now. Thanks, both.
