From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 17 Jan 2017 20:36:15 GMT
Subject: Re: [PATCH] documentation: remove unfinished documentation
Message-ID: <xmqqpojle85c.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20170117200147.25425-1-sbeller@google.com>

Stefan Beller <sbeller@google.com> writes:

> When looking for documentation for a specific function, you may be tempted
> to run
>
>   git -C Documentation grep index_name_pos
>
> only to find the file technical/api-in-core-index.txt, which doesn't
> help for understanding the given function. It would be better to not find
> these functions in the documentation, such that people directly dive into
> the code instead.
>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>
> I run into this a couple of times now, so I put this out tentatively.

These placeholders are meant to encourage those people who dove into
the code to update it, so from that point of view, I think removing
it is backwards.