Boost logo

Boost :

Subject: Re: [boost] Why is the boost documentation so bad?
From: Florian Lindner (mailinglists_at_[hidden])
Date: 2017-09-08 03:04:31


Am 08.09.2017 um 10:51 schrieb Vinnie Falco via Boost:
> On Thu, Sep 7, 2017 at 7:21 PM, Florian Lindner via Boost
> <boost_at_[hidden]> wrote:
>> why is the documentation so bad?
>
> I think it is unfair to say that every library has bad documentation.

You're right of course. This is just an impression I got from the libraries I worked with so far, which logging, test,
ptr_container and some others.

> I would like your opinion, what do you think of these docs?
> <http://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/ref/boost__beast__http__async_write/overload1.html>

This is really much better than most I've seen at other parts of boost.

>
> I realize that quality may vary from library to library. Perhaps you
> can open an issue for your specific documentation problem against that
> particular library?

I can and I will. But I wanted to bring this general issue (and from my perception it is a general issue, with best an
exception) here first.

Best,
Florian


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk