Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improved Getting Started Documentation #446

Open
elfenpiff opened this issue Oct 6, 2024 · 0 comments
Open

Improved Getting Started Documentation #446

elfenpiff opened this issue Oct 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@elfenpiff
Copy link
Contributor

Improvement Suggestion

In https://iceoryx2.readthedocs.io and also our examples we need to clearly define the restrictions on the payload type. On the Rust side we can solve this cleanly with the shmem derive macro but on the C/C++ side we must document it.

It already led to a bug; see #436, so this shall be done sooner rather than later. Otherwise, another user will also run into this pitfall.
@elfenpiff elfenpiff added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@elfenpiff