docs(when_any): clarify wait_for_one_success semantics and patterns#326
Conversation
when_any selects a winner by success (!ec); a failing child neither wins nor cancels its siblings. This was reported as a bug (cppalliance#265) but is by design. Document the behavior explicitly and the two patterns for treating an error as a win, and replace the dangling "see Racing Tasks" reference (which pointed at an unpublished doc/unlisted/ page). - doc/.../4f.composition.adoc: add "Errors Do Not Win" and "Treating an Error as a Win" subsections under when_any; drop the dead reference. - include/boost/capy/when_any.hpp: add a @note to the variadic when_any docstring pointing readers to the patterns.
|
An automated preview of the documentation is available at https://326.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-19 17:14:56 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #326 +/- ##
========================================
Coverage 98.07% 98.07%
========================================
Files 164 164
Lines 8758 8774 +16
========================================
+ Hits 8589 8605 +16
Misses 169 169
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 9 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
|
GCOVR code coverage report https://326.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-19 17:34:28 UTC |
2 participants
when_any selects a winner by success (!ec); a failing child neither wins nor cancels its siblings. This was reported as a bug (#265) but is by design. Document the behavior explicitly and the two patterns for treating an error as a win, and replace the dangling "see Racing Tasks" reference (which pointed at an unpublished doc/unlisted/ page).
Resolves #265