Re: [PATCH] decorate: clean up and document API

2017-12-15 Thread Jeff King
On Mon, Dec 11, 2017 at 10:32:49AM -0800, Jonathan Tan wrote: > > Other than that philosophical point, the documentation you added looks > > pretty good to me. Two possible improvements to the API we could do on > > top: > > > > 1. Should there be a DECORATION_INIT macro (possibly taking the "n

Re: [PATCH] decorate: clean up and document API

2017-12-11 Thread Jonathan Tan
On Fri, 8 Dec 2017 04:55:11 -0500 Jeff King wrote: > I have mixed feelings. On the one hand, compiling and running the code > ensures that those things actually work. On the other hand, I expect you > can make a much clearer example if instead of having running code, you > show snippets of almost

Re: [PATCH] decorate: clean up and document API

2017-12-08 Thread Jeff King
On Thu, Dec 07, 2017 at 04:14:24PM -0800, Jonathan Tan wrote: > Improve the names of the identifiers in decorate.h, document them, and > add an example of how to use these functions. > > The example is compiled and run as part of the test suite. > > Signed-off-by: Jonathan Tan > --- > This patc

[PATCH] decorate: clean up and document API

2017-12-07 Thread Jonathan Tan
Improve the names of the identifiers in decorate.h, document them, and add an example of how to use these functions. The example is compiled and run as part of the test suite. Signed-off-by: Jonathan Tan --- This patch contains some example code in a test helper. There is a discussion at [1] ab