Skip to content

Fix Composed Ops Docs#234

Merged
mvandeberg merged 1 commit intocppalliance:developfrom
mvandeberg:pr/211-composed-docs
Apr 17, 2026
Merged

Fix Composed Ops Docs#234
mvandeberg merged 1 commit intocppalliance:developfrom
mvandeberg:pr/211-composed-docs

Conversation

@mvandeberg
Copy link
Copy Markdown
Contributor

Closes #211

Docs: fix wrong namespaces, signatures, and behavior in composed-ops guide

Fixes #211:

  • corosio::read/write → capy::read/write (correct namespace)
  • Include paths: boost/corosio/ → boost/capy/
  • read-into-string uses string_dynamic_buffer, not bare std::string
  • Return type is io_taskstd::size_t, not task<io_resultstd::size_t>
  • capy::error::eof → capy::cond::eof (error condition, not error code)
  • Remove incorrect write() zero-byte → broken_pipe claim
  • boost::system::system_error → capy::detail::throw_system_error
  • Template constraints use terse syntax matching actual signatures

…guide

Fixes cppalliance#211:
- corosio::read/write → capy::read/write (correct namespace)
- Include paths: boost/corosio/ → boost/capy/
- read-into-string uses string_dynamic_buffer, not bare std::string
- Return type is io_task<std::size_t>, not task<io_result<std::size_t>>
- capy::error::eof → capy::cond::eof (error condition, not error code)
- Remove incorrect write() zero-byte → broken_pipe claim
- boost::system::system_error → capy::detail::throw_system_error
- Template constraints use terse syntax matching actual signatures
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 17, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • doc/modules/ROOT/pages/4.guide/4g.composed-operations.adoc is excluded by !**/doc/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5448b80c-b029-4a79-99e0-1de01ae108ba

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cppalliance-bot
Copy link
Copy Markdown

An automated preview of the documentation is available at https://234.corosio.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-04-17 15:47:39 UTC

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.71%. Comparing base (3fc8c97) to head (ee884cd).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #234   +/-   ##
========================================
  Coverage    77.71%   77.71%           
========================================
  Files           96       96           
  Lines         7298     7298           
  Branches      1787     1787           
========================================
  Hits          5672     5672           
  Misses        1108     1108           
  Partials       518      518           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3fc8c97...ee884cd. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cppalliance-bot
Copy link
Copy Markdown

GCOVR code coverage report https://234.corosio.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://234.corosio.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff Report https://234.corosio.prtest3.cppalliance.org/diff-report/index.html

Build time: 2026-04-17 16:01:47 UTC

@mvandeberg mvandeberg merged commit c2327cf into cppalliance:develop Apr 17, 2026
43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Composed operations doc has wrong namespaces, signatures, and behavior

2 participants