Skip to content

[#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

Merged

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Apr 30, 2025

Notes for Reviewer

Pre-Review Checklist for the PR Author

  • Add sensible notes for the reviewer
  • PR title is short, expressive and meaningful
  • Consider switching the PR to a draft (Convert to draft)
    • as draft PR, the CI will be skipped for pushes
  • Relevant issues are linked in the References section
  • Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  • Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  • Commits messages are according to this guideline
  • Tests follow the best practice for testing
  • Changelog updated in the unreleased section including API breaking changes
  • Assign PR to reviewer
  • All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  • All open points are addressed and tracked via issues

References

Closes #687

Copy link

@Copilot Copilot AI left a 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.

@elfenpiff elfenpiff force-pushed the iox2-687-additional-examples-in-doc branch from e9d0e35 to 2325534 Compare April 30, 2025 12:13
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler left a 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.

@elfenpiff elfenpiff force-pushed the iox2-687-additional-examples-in-doc branch from f196643 to db7ed06 Compare April 30, 2025 14:48
@elfenpiff elfenpiff merged commit 1fbcf46 into eclipse-iceoryx:main Apr 30, 2025
51 of 52 checks passed
@elfenpiff elfenpiff deleted the iox2-687-additional-examples-in-doc branch April 30, 2025 16:34
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.

Example and benchmark for Request Response
2 participants