docs: state Capy positioning, execution invariant, and interop escape…#355
Merged
Merged
Conversation
… hatch Addresses cppalliance#341 and cppalliance#349: the docs never stated capy's value proposition, its core execution invariant, or its foreign-awaitable escape hatch. Documentation: - index.adoc: add "What Capy Is / Is Not" positioning (protocol + reference implementation; the IoAwaitable interop dimension) and an up-front callout of the same-executor invariant. - 4c.executors.adoc: new "The Same-Executor Invariant" section stating the rule, its rationale, and how affinity/run maintain it. - 4d.io-awaitable.adoc: frame IoAwaitable as an interop vocabulary and add "Bridging a Foreign Awaitable" documenting the escape hatch (and why there is no universal auto-bridge). - Two example pages (8o sender bridge, 8p Asio use_capy) plus nav entries. - Clean up stale xrefs to the removed dynamic-buffer pages. - Update the IoAwaitable paper reference from draft D4003 to published P4003. Examples (fix bit-rot from the continuation refactor so the referenced interop examples build and run again): - use_capy.hpp / uni_stream.hpp / capy_streams.cpp: post a continuation through the executor instead of a raw coroutine_handle. - use_capy_example.cpp / any_stream.cpp: writer/reader return io_task<> to satisfy when_all's io_result requirement.
|
An automated preview of the documentation is available at https://355.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-07-02 19:53:01 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop-2 #355 +/- ##
==========================================
Coverage 98.29% 98.29%
==========================================
Files 77 79 +2
Lines 3984 3986 +2
==========================================
+ Hits 3916 3918 +2
Misses 68 68
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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
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.
… hatch
Addresses #341 and #349: the docs never stated capy's value proposition, its core execution invariant, or its foreign-awaitable escape hatch.
Documentation:
Examples (fix bit-rot from the continuation refactor so the referenced interop examples build and run again):