Skip to content

[#4] Fix typos in docs, comments and string literals - #1860

Merged
elfenpiff merged 1 commit into
eclipse-iceoryx:mainfrom
antonkesy:iox2-4-fix-typos
Jul 29, 2026
Merged

[#4] Fix typos in docs, comments and string literals#1860
elfenpiff merged 1 commit into
eclipse-iceoryx:mainfrom
antonkesy:iox2-4-fix-typos

Conversation

@antonkesy

@antonkesy antonkesy commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Notes for Reviewer

This PR fixes typos in docs, comments, and string literals. It should not change any behavior of the code. Similar to eclipse-iceoryx/iceoryx#2539

Should not have any affect on code behavior.

cargo fmt and clang-format did not result in any changes.

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

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

Should not have any affect on code behavior
@dkroenke
dkroenke self-requested a review July 29, 2026 11:14

@dkroenke dkroenke left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution, we should consider to add a spell checker at least for the markdown files. Nothing for this PR though.

@codecov

codecov Bot commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 29.41176% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.37%. Comparing base (178507e) to head (b07c4c6).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
iceoryx2-cal/src/static_storage/file.rs 0.00% 3 Missing ⚠️
...ceoryx2-cal/src/resizable_shared_memory/dynamic.rs 33.33% 2 Missing ⚠️
iceoryx2/src/node/mod.rs 0.00% 2 Missing ⚠️
iceoryx2-bb/posix/src/file.rs 66.66% 1 Missing ⚠️
iceoryx2-cal/src/event/common.rs 0.00% 1 Missing ⚠️
iceoryx2-cal/src/shm_allocator/pool_allocator.rs 0.00% 1 Missing ⚠️
iceoryx2/src/service/resource/blackboard.rs 0.00% 1 Missing ⚠️
iceoryx2/src/service/resource/publish_subscribe.rs 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1860      +/-   ##
==========================================
+ Coverage   76.29%   76.37%   +0.08%     
==========================================
  Files         444      444              
  Lines       44703    44703              
  Branches     1356     1356              
==========================================
+ Hits        34105    34141      +36     
+ Misses       9479     9443      -36     
  Partials     1119     1119              
Flag Coverage Δ
CPP 62.94% <ø> (ø)
Rust 76.26% <29.41%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
iceoryx2-bb/container/src/byte_atomic.rs 95.78% <ø> (ø)
iceoryx2-bb/container/src/semantic_string.rs 82.44% <100.00%> (ø)
iceoryx2-bb/elementary-traits/src/zeroable.rs 75.00% <ø> (ø)
iceoryx2-bb/elementary/src/cyclic_tagger.rs 100.00% <ø> (ø)
iceoryx2-bb/elementary/src/relocatable_pointer.rs 75.00% <ø> (ø)
iceoryx2-bb/elementary/src/unique_id.rs 100.00% <ø> (ø)
iceoryx2-bb/lock-free/src/mpmc/container.rs 96.87% <ø> (ø)
...2-bb/lock-free/src/mpmc/robust_unique_index_set.rs 95.72% <ø> (ø)
iceoryx2-bb/lock-free/src/spsc/queue.rs 96.19% <ø> (ø)
iceoryx2-bb/posix/src/clock.rs 89.20% <ø> (ø)
... and 51 more

... and 7 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@elfenpiff
elfenpiff merged commit 9aeaec2 into eclipse-iceoryx:main Jul 29, 2026
57 checks passed
@elfenpiff

Copy link
Copy Markdown
Contributor

@antonkesy Thank you for the contribution!

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.

3 participants