docs: reconcile manual with code and fix non-compiling examples#329
Conversation
|
An automated preview of the documentation is available at https://329.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-20 22:13:00 UTC |
|
GCOVR code coverage report https://329.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-20 22:28:30 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #329 +/- ##
========================================
Coverage 98.07% 98.07%
========================================
Files 164 164
Lines 8774 8774
========================================
Hits 8605 8605
Misses 169 169
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 3 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
Audited the Antora book and header Javadoc against the implementation and corrected every factual and conceptual discrepancy, treating the code as canonical. Key corrections: - read_some/write_some error contract: n < buffer_size on error, and a full buffer always means success (conditions deferred to the next read); rewrote the chapter 9 rationale and fixed the 9n header misquote - BufferSource/BufferSink: span-based pull/prepare plus consume, matching the real concepts (was pointer+count with integer returns) - cancellation: this_coro::stop_token and error::canceled (removed the nonexistent get_stop_token and error::operation_aborted) - dynamic buffers: fixed-capacity adapters over external storage built via pointer or the dynamic_buffer factory (was grow-on-demand) - any_* wrappers: owning by value vs reference by pointer (no S& ctor) - IoAwaitable/IoRunnable concepts, Executor concept, composed-op return types (io_task), and assorted symbol/path fixes Verified all 489 code examples compile against the real API. Fixed real breakage: mutable_buffer(array) to make_buffer, co_await std::move on a named task, the mmap_source io_result return, the fabricated test::stream(fuse) constructor, and buffer_to_string on bufgrind slices. Build instructions link capy with no external dependencies, and the thread_pool examples call join() to drain outstanding work.
2 participants
Audited the Antora book and header Javadoc against the implementation and corrected every factual and conceptual discrepancy, treating the code as canonical.
Key corrections:
Verified all 489 code examples compile against the real API. Fixed real breakage: mutable_buffer(array) to make_buffer, co_await std::move on a named task, the mmap_source io_result return, the fabricated test::stream(fuse) constructor, and buffer_to_string on bufgrind slices.
Build instructions link capy with no external dependencies, and the thread_pool examples call join() to drain outstanding work.