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.

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

iox-#743 Fix spelling mistakes in docu, adjust waitset examples #849

Merged

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Jun 14, 2021

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Branch follows the naming format (iox-#123-this-is-a-branch)
  4. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  5. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  6. Relevant issues are linked
  7. Add sensible notes for the reviewer
  8. All checks have passed (except task-list-completed)
  9. Assign PR to reviewer

Notes for Reviewer

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

… examples

renamed waitset_sync into waitset_timer_driven_execution

Signed-off-by: Christian Eltzschig <[email protected]>
@codecov
Copy link

codecov bot commented Jun 14, 2021

Codecov Report

Merging #849 (3c685cf) into master (eb02564) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #849      +/-   ##
==========================================
+ Coverage   75.05%   75.06%   +0.01%     
==========================================
  Files         332      332              
  Lines       11863    11864       +1     
  Branches     2001     2001              
==========================================
+ Hits         8904     8906       +2     
  Misses       2190     2190              
+ Partials      769      768       -1     
Flag Coverage Δ
unittests 73.94% <ø> (+0.01%) ⬆️
unittests_timing 30.84% <ø> (+0.30%) ⬆️

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

Impacted Files Coverage Δ
iceoryx_posh/source/roudi/process_manager.cpp 60.05% <0.00%> (-0.30%) ⬇️
iceoryx_posh/source/roudi/memory/memory_block.cpp 66.66% <0.00%> (ø)
...osh/source/roudi/memory/port_pool_memory_block.cpp 92.85% <0.00%> (ø)
...include/iceoryx_posh/roudi/memory/memory_block.hpp 100.00% <0.00%> (ø)
...iceoryx_posh/roudi/memory/generic_memory_block.hpp 100.00% <0.00%> (ø)
...h/internal/roudi/memory/port_pool_memory_block.hpp 100.00% <0.00%> (ø)
iceoryx_hoofs/source/concurrent/loffli.cpp 85.29% <0.00%> (+5.88%) ⬆️

elfenpiff and others added 2 commits June 14, 2021 11:11
Signed-off-by: Christian Eltzschig <[email protected]>
… and update admonition

Signed-off-by: Simon Hoinkis <[email protected]>
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Jun 14, 2021
@mossmaurice mossmaurice linked an issue Jun 14, 2021 that may be closed by this pull request
53 tasks
@elfenpiff elfenpiff merged commit 434fb33 into eclipse-iceoryx:master Jun 15, 2021
@elfenpiff elfenpiff deleted the iox-#743-fix-docu-spelling-mistakes branch June 15, 2021 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation and website for v2.0
3 participants