Skip to content

docs: document quitter and the other toolkit examples in the manual #409

Closed

Description

@sgerbino

From the review result:

Then I found, not in the docs, but in the examples from the repo the 'quitter' example [...] it's clear from the example that outside of task Capy has other not well documented 'toolkit elements'. [...] why leave this stuff in if it's not really documented?

Source: Boost review result (conditional acceptance), Boost mailing list, September 2026.

quitter is a first-class library type (tested, reference-documented) but has no manual page and no nav entry; its design rationale lives in doc/quitter.md, a loose file outside the Antora tree that never renders. The same gap applies to async_mutex, async_event, async_waker (reference-only) and to examples that ship without a docs page (when-any-cancellation, fabrics, cuda, asio interop).

  • Manual page for quitter (when to prefer it over task, shutdown pattern) plus a nav entry for the example
  • Manual coverage for the synchronization primitives (async_mutex, async_event, async_waker)
  • Move or merge doc/quitter.md into the Antora tree
  • Docs pages (or nav entries) for the remaining undocumented examples

Activity

  1. moved this from Backlog to Ready in Beast2on Sep 8, 2026
  2. self-assigned this
    on Oct 21, 2026
  3. moved this from Ready to In progress in Beast2on Oct 21, 2026
  4. moved this from In progress to Ready in Beast2on Nov 5, 2026
  5. sgerbino commented on Nov 5, 2026

    @sgerbino
    CollaboratorAuthor

    We changed the code under #481. Now we need to figure out how to work it into the documentation to satisfy the boost review.

  6. TheLingeringWill commented on Nov 9, 2026

    @TheLingeringWill
    Contributor

    I’d like to take this one.

  7. moved this from Ready to In progress in Beast2on Nov 9, 2026
  8. moved this from In progress to In review in Beast2on Nov 10, 2026
  9. moved this from In review to Done in Beast2on Nov 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions