-
Notifications
You must be signed in to change notification settings - Fork 61
[#687] additional examples in doc #713
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[#687] additional examples in doc #713
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds additional documentation examples for various service types and client/server APIs across the codebase.
- Expanded doc comments for Typed API in both server and client builders.
- Added detailed Request-Response examples in the library documentation and README.
- Updated documentation for Publish-Subscribe and custom service attributes.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
iceoryx2/src/service/port_factory/server.rs | Added Typed API documentation including unable_to_deliver_strategy. |
iceoryx2/src/service/mod.rs | Expanded documentation for Request-Response, Publish-Subscribe, Event, and custom configurations. |
iceoryx2/src/port/client.rs | Updated Typed API docs to include unable_to_deliver_strategy in client builder. |
iceoryx2/src/lib.rs | Added comprehensive Request-Response examples with multiple replies. |
README.md | Introduced Request Response example snippets for client and server. |
e9d0e35
to
2325534
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some nitpicks, up to you if you want to fix the typos or merge.
d73861d
to
f196643
Compare
f196643
to
db7ed06
Compare
Notes for Reviewer
Pre-Review Checklist for the PR Author
Convert to draft
)SPDX-License-Identifier: Apache-2.0 OR MIT
iox2-123-introduce-posix-ipc-example
)[#123] Add posix ipc example
)task-list-completed
)Checklist for the PR Reviewer
Post-review Checklist for the PR Author
References
Closes #687