Skip to content

Consolidate return value info for boost::capy::timeout #292

@PeterTurcan

Description

@PeterTurcan

Currently there is both a Return Type and Return Value section for this function. The Return Value only contains task<awaitable_result_t[>]. - which looks like a formatting error at the end [>].

Only one entry is needed, perhaps choose Return Value for consistency, remove the other one, and ensure the description is complete. Is it true that the function "Always returns Io...." - is this true if an error is set? Otherwise say, "On successful completion, this function returns ......" in which case ec is set to null. If ec is set to an error - the returned value is undefined" - or similar.

This sentence should have an initial cap:
any exception from the inner awaitable, regardless of whether the timer has fired.

The Precision entry is unnecessary: add the sentence to the description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions