Skip to content

Add the reference example for io_context::service - #379

Merged
sgerbino merged 1 commit into
cppalliance:developfrom
sgerbino:pr/mrdocs-service-snippet
Oct 2, 2026
Merged

sgerbino merged 1 commit into
cppalliance:developfrom
sgerbino:pr/mrdocs-service-snippet

Conversation

@sgerbino

@sgerbino sgerbino commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator

Recent MrDocs develop-release builds extract inherited members, so io_context now lists service — inherited from capy::execution_context — whose docstring carries an @par !example marker. The reference-snippets extension then requires test/doc/reference/io_context__service.record.cpp, which did not exist, failing every fresh docs build (develop's last green run predates the MrDocs change; nothing in this repo changed).

This adds the snippet, adapted from capy's execution_context::service example to corosio idiom (io_context + use_service). Compiles in the boost_corosio_doc_tests target.

Worth considering separately: pinning MrDocs to a release tag instead of the floating develop-release asset, so fresh CI runs stop changing behavior without a commit.

(Supersedes #378, which was opened from a branch on the main repository by mistake.)

Recent MrDocs develop-release builds list inherited members, so
io_context now carries capy's execution_context::service docstring,
whose example marker expects a snippet file in this repository. Without
it the reference-snippets extension fails the whole docs build.
@cppalliance-bot

Copy link
Copy Markdown

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

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

2026-10-02 19:20:14 UTC

@sgerbino
sgerbino marked this pull request as ready for review October 2, 2026 19:24
@cppalliance-bot

Copy link
Copy Markdown

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

Build time: 2026-10-02 19:32:08 UTC

@sgerbino
sgerbino merged commit a80ce00 into cppalliance:develop Oct 2, 2026
126 of 127 checks passed
@sgerbino
sgerbino deleted the pr/mrdocs-service-snippet branch October 2, 2026 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants