docs(timeout): consolidate return-value docs and fix rendering (#292)#309
Merged
mvandeberg merged 1 commit intoJun 10, 2026
Merged
Conversation
…liance#292) Rewrite the boost::capy::timeout docstring to address reviewer feedback: - Remove the custom @Par Return Type block, leaving a single @return ("Return Value") section consistent with delay(). - Replace `@return task<awaitable_result_t<A>>` (which rendered as `task<awaitable_result_t[>]` because <A> was stripped as an HTML tag) with prose describing the value using io_result<Ts...>, spelling out the success / inner-error / timeout outcomes. - Capitalize the @throws description ("Any exception ..."). - Fold the lone @Par Precision sentence into the opening paragraph.
|
An automated preview of the documentation is available at https://309.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-06-10 17:41:21 UTC |
|
GCOVR code coverage report https://309.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-10 17:54:40 UTC |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrite the boost::capy::timeout docstring to address reviewer feedback:
@return task<awaitable_result_t<A>>(which rendered astask<awaitable_result_t[>]because was stripped as an HTML tag) with prose describing the value using io_result<Ts...>, spelling out the success / inner-error / timeout outcomes.Resolves #292