Skip to content

docs: give io_result a page of its own and annotate the early examples #405

Description

@sgerbino

From the review result:

io_result needs to be front and center in the Capy docs -- it is in the Corosio docs, but it's buried in the task section of the Capy docs. That is, of course, partially how it is used as an unnamed return value split into elements. Comments in some early examples with a link to the reference could help.

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

io_result is covered inside 4a.tasks.adoc with no nav entry of its own. The landing-page Quick Example opens with auto [ec, n] = co_await stream.read_some(...) with no comment or link explaining the pattern; the quick start and first example page do not introduce it either.

  • Dedicated page or top-level nav entry for io_result / io_task
  • One-line comment plus reference link in the landing-page and quick-start examples

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions