Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cheat sheet fixes #101

Open
ned14 opened this issue Aug 28, 2015 · 0 comments
Open

Cheat sheet fixes #101

ned14 opened this issue Aug 28, 2015 · 0 comments

Comments

@ned14
Copy link
Member

ned14 commented Aug 28, 2015

Change:
Boost.AFIO version 1.4 provides the following operations:

To:

Boost.AFIO version 1.4 provides the following operations: (number of
overloads)

BUT, do you need to tell us this? I think a "YES" in the cells where you
have numbers is all we need to know. There is already too much information
on this page, considering it is supposed to be a "single page cheat
sheet".

The art in technical writing is to remove as much as possible from your
first full draft. E.g. your first two bullet points could instead be:

  • AFIO models file handles as a reference counted std::shared_ptr

    ** handle could represent a closed file descriptor/handle, not just an
    open one.

    ** You can create your own custom implementations of handle.

  • AFIO models a filesystem as a reference counted
    std::shared_ptr

    ** When constructed using make_dispatcher() you specify a URI such as
    file:///.

    ** You can create your own custom dispatcher implementations.

HTH,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant