curl / Mailing Lists / curl-library / Single Mail

curl-library

Re: Combining related man pages

From: Philip Prindeville <philipp_subx_at_redfish-solutions.com>
Date: Mon, 23 Apr 2018 16:43:29 -0600

> On Apr 23, 2018, at 3:20 PM, Daniel Stenberg <daniel_at_haxx.se> wrote:
>
> On Mon, 23 Apr 2018, Philip Prindeville wrote:
>
>> I was just looking at the contents of docs/libcurl/opts as I work on PR #2495, and was wondering why options like CURLINFO_FILETIME and CURLINFO_FILETIME_T don’t share the same page, since they’re just different versions of the same thing?
>
> There are a few reasons:
>
> 1. I find it clearer and more straight-forward to only document a single function on that single page. Clearer for the reader that is.
>
> 2. It was very easy to do.
>
> 3. Our infrastrcture on the web site (that generates the contents) and tests etc presume this one to one mapping in several places, so it has also been a matter of going with the least resistance or least amount of extra work.
>
> None of them are very strong or says we can't change how things are going forward.
>

Okay, understood.

Long-term, I thought being able to see at a glance all the different ways to do the same thing gives the most information at once to a new developer unfamiliar with everything that’s available…

But for my own PR I’ll proceed with separate pages.

-------------------------------------------------------------------
Unsubscribe: https://cool.haxx.se/list/listinfo/curl-library
Etiquette: https://curl.haxx.se/mail/etiquette.html
Received on 2018-04-24