Skip to content

Fix NOTE admonitions to include code snippets#206

Merged
sgerbino merged 1 commit intocppalliance:developfrom
sgerbino:pr/doc-note
Mar 12, 2026
Merged

Fix NOTE admonitions to include code snippets#206
sgerbino merged 1 commit intocppalliance:developfrom
sgerbino:pr/doc-note

Conversation

@sgerbino
Copy link
Collaborator

The single-line NOTE: shorthand only captures one line of text, leaving the code block rendered outside the admonition. Use the block form [NOTE]/==== to wrap the code snippet inside.

The single-line NOTE: shorthand only captures one line of text,
leaving the code block rendered outside the admonition. Use the
block form [NOTE]/==== to wrap the code snippet inside.
@coderabbitai
Copy link

coderabbitai bot commented Mar 12, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (18)
  • doc/modules/ROOT/pages/3.tutorials/3a.echo-server.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/3.tutorials/3b.http-client.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/3.tutorials/3c.dns-lookup.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/3.tutorials/3d.tls-context.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4c.io-context.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4d.sockets.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4e.tcp-acceptor.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4f.endpoints.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4g.composed-operations.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4h.timers.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4i.signals.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4j.resolver.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4k.tcp-server.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4l.tls.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4m.error-handling.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/4.guide/4n.buffers.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/5.testing/5a.mocket.adoc is excluded by !**/doc/**
  • doc/modules/ROOT/pages/quick-start.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: 0b2eec50-772f-4037-8a38-aab7594443ff

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
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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

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

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

2026-03-12 17:11:57 UTC

@cppalliance-bot
Copy link

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

Build time: 2026-03-12 17:21:50 UTC

@codecov
Copy link

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.25%. Comparing base (6d10efa) to head (2d8ab40).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #206   +/-   ##
========================================
  Coverage    76.25%   76.25%           
========================================
  Files           99       99           
  Lines        10570    10570           
  Branches      2407     2407           
========================================
  Hits          8060     8060           
  Misses        1797     1797           
  Partials       713      713           

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 6d10efa...2d8ab40. Read the comment docs.

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

@sgerbino sgerbino merged commit d58f3e6 into cppalliance:develop Mar 12, 2026
44 checks passed
@sgerbino sgerbino deleted the pr/doc-note branch March 12, 2026 19:05
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.

2 participants