Correct documentation typo

[cerdelen]

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
• [~] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
• Commits messages are according to this guideline
  • Commit messages have the issue ID ([#123] Add posix ipc example)
  • Keep in mind to use the same email that was used to sign the Eclipse Contributor Agreement
• [~] 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)

PR Reviewer Reminders

• 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

References

Relates to #4

[elBoberido]

Thanks for your contribution.

Since we are targeting the safety domain, we need to follow some formalism. One is to always have commits referring to an issue number. For documentation fixes, we have a generic issue (#4). Can you please change the commit message to [#4] Correct documentation typo?

Please also do not delete the content of the PR template. This gives you and also the committer instructions on what do check during the PR. I'll recreate it for you.

[elBoberido]

@cerdelen did you already sign the ECA? If you already did, it takes a bit until everything is synced, so we just have to wait a little bit.

[cerdelen]

@elBoberido I actually just did it a few min ago.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.81%. Comparing base (d2ce0e6) to head (1ef0740).
⚠️ Report is 26 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1340      +/-   ##
==========================================
- Coverage   77.83%   77.81%   -0.02%     
==========================================
  Files         412      412              
  Lines       39008    39008              
  Branches     1256     1256              
==========================================
- Hits        30360    30355       -5     
- Misses       7615     7620       +5     
  Partials     1033     1033              

Flag	Coverage Δ
CPP	68.04% <ø> (ø)
Rust	77.66% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 5 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[elBoberido]

@cerdelen the ECA check can still do not find your account. Maybe it just takes longer than expected but just in case, you registered with the same email address you used for the commits, right?

[cerdelen]

Oh i think the problem is that my email address on github is written with a '.' and eclipse doesn't like that so i used it without dot (which still leads to the same email account).

[elBoberido]

@cerdelen it must match exactly the email address you used in your commits, else the ECA check will fail.