Revise documentation for 3.3.0 #272
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR revises the documentation for release 3.3.0 by updating version numbers and refining template constraints, examples, and links. Key changes include adding documentation for the new support_weak feature, revising proxy maker functions and allocator usage, and correcting minor typos and link errors.
Reviewed Changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/basic_facade_builder/support_weak.md | Added documentation for the new support_weak feature. |
| docs/make_proxy_view.md | Updated example code with run links and polished descriptions. |
| docs/make_proxy_shared.md | Revised examples and descriptions for proxy shared creation. |
| docs/allocate_proxy_shared.md | Clarified allocator usage and shared proxy details. |
| docs/proxiable_target.md | Provided updated examples for the proxiable_target concept. |
| docs/implicit_conversion_dispatch.md | Removed an unnecessary include to streamline the example. |
| docs/make_proxy.md | Updated template constraints and standardized allocator usage. |
| docs/ProReflection.md | Minor formatting adjustments in the documentation. |
| docs/inplace_proxiable_target.md | Fixed link typos and updated concept usage details. |
| docs/PRO_DEF_FREE_AS_MEM_DISPATCH.md | Revised accessor templates to include a new bool parameter. |
| docs/make_proxy_inplace.md | Replaced sbo-ptr references with inplace-ptr and updated requirements. |
| docs/allocate_proxy.md | Added notes regarding proxiable_target constraints for version 3.3.0. |
| docs/msft_lib_proxy.md | Updated version information to reflect 3.3.0. |
| docs/formatter_proxy_indirect_accessor.md | Updated template constraints; note potential typo in a template parameter. |
| docs/access_proxy.md | Standardized template signatures with facade requirements. |
| docs/basic_facade_builder.md | Extended the documentation to include support_weak details. |
| docs/proxiable.md | Refined descriptive text for the proxiable concept. |
| docs/facade_aware_overload_t.md | Updated overload template signatures with proper facade constraints. |
Comments suppressed due to low confidence (1)
docs/formatter_proxy_indirect_accessor.md:4
- It appears that 'ChatT' is a typo; it should likely be 'CharT' to match the template parameter declaration.
struct formatter<pro::proxy_indirect_accessor<F>, ChatT>; // since 3.2.0
guominrui
previously approved these changes
Mar 17, 2025
tian-lt
reviewed
Mar 18, 2025
tian-lt
approved these changes
Mar 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pumped library version to
202503L. No functional changes.