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 Fixes to make docs exportable (v2.x) #1289

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Mar 15, 2022

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. Changelog updated in the unreleased section including API breaking changes
  4. Branch follows the naming format (iox-#123-this-is-a-branch)
  5. 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)
  6. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  7. Relevant issues are linked
  8. Add sensible notes for the reviewer
  9. All checks have passed (except task-list-completed)
  10. Assign PR to reviewer

Notes for Reviewer

  • Minor fixes to make the docs exportable

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
    • Each unit test case has a unique UUID
  • 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

@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Mar 15, 2022
@mossmaurice mossmaurice self-assigned this Mar 15, 2022
@mossmaurice mossmaurice requested a review from elfenpiff March 15, 2022 11:00
@mossmaurice mossmaurice changed the title iox-#743 Fixes to make docs exportable iox-#743 Fixes to make docs exportable [v2.x] Mar 15, 2022
@mossmaurice mossmaurice changed the title iox-#743 Fixes to make docs exportable [v2.x] iox-#743 Fixes to make docs exportable (v2.x) Mar 15, 2022
@codecov
Copy link

codecov bot commented Mar 15, 2022

Codecov Report

Merging #1289 (7763b74) into release_2.0 (91dd909) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@               Coverage Diff               @@
##           release_2.0    #1289      +/-   ##
===============================================
- Coverage        78.94%   78.93%   -0.01%     
===============================================
  Files              370      370              
  Lines            14706    14705       -1     
  Branches          2059     2059              
===============================================
- Hits             11609    11608       -1     
  Misses            2417     2417              
  Partials           680      680              
Flag Coverage Δ
unittests 78.17% <100.00%> (+0.01%) ⬆️
unittests_timing 15.48% <0.00%> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
iceoryx_posh/source/roudi/port_manager.cpp 84.24% <100.00%> (-0.03%) ⬇️
iceoryx_hoofs/source/posix_wrapper/timer.cpp 63.07% <0.00%> (-0.83%) ⬇️
...nternal/roudi/introspection/port_introspection.inl 82.84% <0.00%> (+0.72%) ⬆️

@mossmaurice mossmaurice merged commit 73d6d59 into eclipse-iceoryx:release_2.0 Mar 16, 2022
@mossmaurice mossmaurice deleted the iox-#743-export-docs-to-iceoryx-io branch March 16, 2022 09:32
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.

3 participants