Skip to content

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

Closed
sgerbino wants to merge 1 commit into
developfrom
pr/mrdocs-service-snippet
Closed

sgerbino wants to merge 1 commit into
developfrom
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.

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.
@sgerbino
sgerbino marked this pull request as ready for review October 2, 2026 18:50
@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://378.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 18:55:17 UTC

@cppalliance-bot

Copy link
Copy Markdown

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

Build time: 2026-10-02 19:10:50 UTC

@sgerbino

sgerbino commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator Author

Reopening from the fork — branch didn't belong on the main repo.

@sgerbino sgerbino closed this Oct 2, 2026
@sgerbino
sgerbino deleted the pr/mrdocs-service-snippet branch October 2, 2026 19:13
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Beast2 Oct 2, 2026
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.

2 participants