doc work cont. #44
doc work cont. #44
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on improving code organization and documentation clarity. The main purpose is to move type traits utilities into a proper namespace and fix minor documentation issues.
Key changes:
- Moved
void_tutility intodetailnamespace for better code organization - Updated all references to use the namespaced version (
detail::void_t) - Fixed minor documentation formatting and grammar issues
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| include/boost/buffers/detail/config.hpp | Moved void_t utility into detail namespace |
| include/boost/buffers/dynamic_buffer.hpp | Updated to use detail::void_t and reformatted template parameters |
| include/boost/buffers/detail/type_traits.hpp | Updated to use detail::void_t |
| include/boost/buffers/detail/is_span.hpp | Updated to use detail::void_t |
| include/boost/buffers/buffer.hpp | Updated to use detail::void_t |
| doc/modules/ROOT/pages/1.intro.adoc | Fixed grammar and removed extra whitespace in documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| two separate contiguous memory regions, occur in design patterns with sufficient | ||
| frequency that the library provides a custom implementation for representing | ||
| them. Objects of type cpp:const_buffer_pair[] or cpp::mutable_buffer_pair[] are | ||
| them. Objects of types cpp:const_buffer_pair[] and cpp:mutable_buffer_pair[] are |
There was a problem hiding this comment.
The word 'types' should be 'type' to maintain grammatical consistency with the singular 'Objects'.
| them. Objects of types cpp:const_buffer_pair[] and cpp:mutable_buffer_pair[] are | |
| them. Objects of type cpp:const_buffer_pair[] and cpp:mutable_buffer_pair[] are |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Perhaps a style comment, I think the original is more grammatically correct.
(also the copilot suggestion is the worst of the 3)
|
An automated preview of the documentation is available at https://44.buffers.prtest.cppalliance.org/index.html |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #44 +/- ##
========================================
Coverage 98.69% 98.69%
========================================
Files 13 13
Lines 611 611
========================================
Hits 603 603
Misses 8 8
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
|
An automated preview of the documentation is available at https://44.buffers.prtest.cppalliance.org/index.html |
|
An automated preview of the documentation is available at https://44.buffers.prtest.cppalliance.org/index.html |
|
An automated preview of the documentation is available at https://44.buffers.prtest.cppalliance.org/index.html |
| two separate contiguous memory regions, occur in design patterns with sufficient | ||
| frequency that the library provides a custom implementation for representing | ||
| them. Objects of type cpp:const_buffer_pair[] or cpp::mutable_buffer_pair[] are | ||
| them. Objects of types cpp:const_buffer_pair[] and cpp:mutable_buffer_pair[] are |
There was a problem hiding this comment.
Perhaps a style comment, I think the original is more grammatically correct.
(also the copilot suggestion is the worst of the 3)
| //------------------------------------------------ | ||
|
|
||
| // avoid all of Boost.TypeTraits for just this | ||
| namespace detail { |
There was a problem hiding this comment.
Do these definitions better belong here or in buffers/detail/type_traits.hpp ?
There was a problem hiding this comment.
it could be moved I suppose. the thinking is that we can avoid detail/type_traits.hpp in some cases
There was a problem hiding this comment.
for example detail/is_span.hpp would have to include detail/type_traits.hpp which includes , needlessly if we move void_t
No description provided.