Re: [ boost.out_ptr ] [ Review Endorsement ] New Library targeting C++11

From: Gottlob Frege (gottlobfrege_at_[hidden])
Date: 2019-05-27 21:18:15

On Mon, May 27, 2019 at 4:29 AM Hans Dembinski via Boost
<boost_at_[hidden]> wrote:
>
> Hi,
>
> > On 27. May 2019, at 08:00, JeanHeyd Meneide via Boost <boost_at_[hidden]> wrote:
> >
> >     After a lot of work and discussion in-person, via e-mail, and on the
> > Slack, I would like to ask for the library boost.out_ptr
> > <https://github.com/ThePhD/out_ptr/blob/master/docs/out_ptr.adoc> --
> > targeting C++11 -- to be endorsed for review.
> >
> >     Documentation: ascii doc-ready and readable on GitHub
> > <https://github.com/ThePhD/out_ptr/blob/master/docs/out_ptr.adoc>
> >     Repository: GitHub <https://github.com/ThePhD/out_ptr>
> >     Standards Proposal: p1132
> > <https://thephd.github.io/vendor/future_cxx/papers/d1132.html> (accepted
> > for and targeting C++20)
>
> this seems like a useful project, but reading the docs is frustrating. I find them less approachable than they should be. Here is some feedback:
>
> https://github.com/ThePhD/out_ptr/blob/master/docs/out_ptr/rationale.adoc
>
> It should be explained what CTAD is and/or a link to its definition should be provided. Just dropping acronyms is bad. If the authors expect the user to read p1132, before reading this page, that should be stated here.

Get accustomed to this one, it goes along with SFINAE, RAII, and
CPPIBAA (C++ Is Bad At Acronyms).

Many docs probably skip explaining SFINAE or RAII, but CTAD is still
new, so, yeah, it would be great to throw in the definition.

Tony