Re: [PATCH] document string_list_clear

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Dec 10, 2014, 23:08 UTC
Message-ID: <20141210230827.GH16345@google.com>
In-Reply-To: <xmqq61djf6nq.fsf@gitster.dls.corp.google.com>

Junio C Hamano wrote:

> Jonathan Nieder <jrnieder@gmail.com> writes:

Show 5 quoted lines

>>  2. Move documentation to header, being careful enough that the header
>>     sort of works as a standalone document.
>>
>>  3. Move documentation to Documentation/technical/ and keep the header
>>     bare-bones.

[...]

Show 5 quoted lines

> I am not sure if (2) and (3) are that incompatible, though.  If you
> had an acceptable version of (3), wouldn't it be just the matter of
> indenting the whole thing with "s/^/ */", sprinkle "/**" and "*/" at
> strategic paragraph breaks, and move them back to the corresponding
> header?

Presumably. There's also the question of whether to use asciidoc markup, which got mixed in somehow (but I don't see why it has to be --- a header with asciidoc would be fine with me, as would a file in Documentation/technical/ without asciidoc).