Fix spelling, grammar, and stale identifiers in docs and Javadocs#222
Fix spelling, grammar, and stale identifiers in docs and Javadocs#222sgerbino merged 1 commit intocppalliance:developfrom
Conversation
- doc/reference/concurrency-1.md: fix misspellings (exmaple_thread, initiazer), grammar errors, and remove duplicated content - doc 4c.executors.adoc: correct "two methods" to "three methods" - doc 8l.RunApi.adoc: fix garbled section symbol - doc why-capy.adoc: hyphenate "twenty-five", fix "with over decades" - task.hpp, thread_pool.hpp: fix stale repository URLs - io_awaitable.hpp, io_awaitable_promise_base.hpp: env->allocator and this_coro::allocator to env->frame_allocator and this_coro::frame_allocator - dynamic_buffer.hpp: string_buffers to string_dynamic_buffer with correct pointer syntax in code examples
📝 WalkthroughWalkthroughThis PR updates documentation and semantic requirements across concept and implementation headers, primarily renaming allocator references to frame_allocator in coroutine context and correcting repository URLs. No functional API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
include/boost/capy/ex/io_awaitable_promise_base.hpp (1)
36-42:⚠️ Potential issue | 🟡 MinorFinish the terminology rename in the environment description.
Line 37 still says the stored
io_envcontains anallocator, but the public member isframe_allocator. Leaving the old term here makes this block inconsistent with the updated accessors and examples below.✏️ Proposed fix
- 2. **Environment storage** — The mixin stores a pointer to the `io_env` - containing the executor, stop token, and allocator for this coroutine. + 2. **Environment storage** — The mixin stores a pointer to the `io_env` + containing the executor, stop token, and frame allocator for this coroutine.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@include/boost/capy/ex/io_awaitable_promise_base.hpp` around lines 36 - 42, Update the environment description to use the new terminology: replace the word "allocator" with "frame_allocator" when describing the stored io_env so it matches the public member names and the accessors; ensure the sentence that currently reads "containing the executor, stop token, and allocator" instead references "executor, stop token, and frame_allocator" and remains consistent with this_coro::environment, this_coro::executor, this_coro::stop_token, and this_coro::frame_allocator.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@include/boost/capy/ex/io_awaitable_promise_base.hpp`:
- Around line 36-42: Update the environment description to use the new
terminology: replace the word "allocator" with "frame_allocator" when describing
the stored io_env so it matches the public member names and the accessors;
ensure the sentence that currently reads "containing the executor, stop token,
and allocator" instead references "executor, stop token, and frame_allocator"
and remains consistent with this_coro::environment, this_coro::executor,
this_coro::stop_token, and this_coro::frame_allocator.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 45f9c964-5d7d-411a-af88-9fbdda261133
⛔ Files ignored due to path filters (4)
doc/modules/ROOT/pages/4.coroutines/4c.executors.adocis excluded by!**/doc/**doc/modules/ROOT/pages/8.design/8l.RunApi.adocis excluded by!**/doc/**doc/modules/ROOT/pages/why-capy.adocis excluded by!**/doc/**doc/reference/concurrency-1.mdis excluded by!**/doc/**
📒 Files selected for processing (5)
include/boost/capy/concept/dynamic_buffer.hppinclude/boost/capy/concept/io_awaitable.hppinclude/boost/capy/ex/io_awaitable_promise_base.hppinclude/boost/capy/ex/thread_pool.hppinclude/boost/capy/task.hpp
|
An automated preview of the documentation is available at https://222.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-03-09 21:11:53 UTC |
|
GCOVR code coverage report https://222.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-03-09 21:28:07 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #222 +/- ##
===========================================
+ Coverage 92.14% 92.41% +0.26%
===========================================
Files 77 81 +4
Lines 4534 4652 +118
===========================================
+ Hits 4178 4299 +121
+ Misses 356 353 -3
... and 10 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
2 participants
Summary by CodeRabbit