On 09/09/2012 11:54 AM, Junio C Hamano wrote:
Michael Haggerty mhag...@alum.mit.edu writes:
[...]
diff --git a/Documentation/technical/api-string-list.txt
b/Documentation/technical/api-string-list.txt
index 9206f8f..291ac4c 100644
--- a/Documentation/technical/api-string-list.txt
+++
Michael Haggerty mhag...@alum.mit.edu writes:
Another idea: in string-list.h, one could name parameters sorted_list
when they must be sorted as a precondition of the function.
That sounds like a very sensible thing to do.
But before getting too hung up on finery, the effort might be better
On Mon, Sep 10, 2012 at 09:24:17AM -0700, Junio C Hamano wrote:
While we're on the subject, it seems to me that documenting APIs like
these in separate files under Documentation/technical rather than in the
header files themselves
- makes the documentation for a particular function
On 09/10/2012 06:33 PM, Jeff King wrote:
On Mon, Sep 10, 2012 at 09:24:17AM -0700, Junio C Hamano wrote:
While we're on the subject, it seems to me that documenting APIs like
these in separate files under Documentation/technical rather than in the
header files themselves
- makes the
I'm renaming this thread so that the bikeshedding can get over ASAP.
On 09/10/2012 07:48 PM, Andreas Ericsson wrote:
On 09/10/2012 06:33 PM, Jeff King wrote:
On Mon, Sep 10, 2012 at 09:24:17AM -0700, Junio C Hamano wrote:
Michael Haggerty mhag...@alum.mit.edu writes:
Also, better
On Mon, Sep 10, 2012 at 09:21:12PM +0200, Michael Haggerty wrote:
I'm renaming this thread so that the bikeshedding can get over ASAP.
Thanks. :)
http://tomdoc.org/
Looks much nicer to me than most doxygen I've seen. But again, it's been
a while, so maybe doxygen is nicer than I
On 09/10/2012 11:56 PM, Jeff King wrote:
On Mon, Sep 10, 2012 at 09:21:12PM +0200, Michael Haggerty wrote:
My plate is full. If you are able to work on this, it would be awesome.
As far as I'm concerned, you are the new literate documentation czar :-)
Lucky me? :)
I was nominating
On 09/10/2012 11:56 PM, Jeff King wrote:
On Mon, Sep 10, 2012 at 09:21:12PM +0200, Michael Haggerty wrote:
I'm renaming this thread so that the bikeshedding can get over ASAP.
Thanks. :)
http://tomdoc.org/
Looks much nicer to me than most doxygen I've seen. But again, it's been
a
Michael Haggerty mhag...@alum.mit.edu writes:
Signed-off-by: Michael Haggerty mhag...@alum.mit.edu
---
Documentation/technical/api-string-list.txt | 8
string-list.c | 20 +++
string-list.h | 8
Signed-off-by: Michael Haggerty mhag...@alum.mit.edu
---
Documentation/technical/api-string-list.txt | 8
string-list.c | 20 +++
string-list.h | 8
t/t0063-string-list.sh | 30
10 matches
Mail list logo