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

Fix tutorial snippets with new Doxygen filters #316

Merged
merged 1 commit into from
Dec 21, 2021

Conversation

mabelzhang
Copy link
Contributor

🦟 Bug fix

Followup of #312
Depends on gazebosim/gz-cmake#198

Summary

With gazebosim/gz-cmake#198 , now the snippets in tutorials 5, 7, 8 show up correctly.

Recompile

colcon build --packages-select ignition-physics6 ignition-cmake2 --merge-install

(Is it okay for this PR to target ign-physics main and that one to ign-cmake2? The tutorials are only fixed on main and not Garden. Can backport to ign-physics5 if needed.)

Navigate to those 3 tutorials from the local page, and check that the snippets to CMakeLists.txt, dartsim/*/.cc, and dartsim/*/.hh are showing:

file:///path/to/ign/build/ignition-physics6/doxygen/html/tutorials.html

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@codecov
Copy link

codecov bot commented Dec 18, 2021

Codecov Report

Merging #316 (6ad7674) into main (0b57581) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #316   +/-   ##
=======================================
  Coverage   75.54%   75.54%           
=======================================
  Files         127      127           
  Lines        5655     5655           
=======================================
  Hits         4272     4272           
  Misses       1383     1383           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0b57581...6ad7674. Read the comment docs.

@chapulina chapulina added the documentation Improvements or additions to documentation label Dec 20, 2021
@chapulina
Copy link
Contributor

(Is it okay for this PR to target ign-physics main and that one to ign-cmake2? The tutorials are only fixed on main and not Garden. Can backport to ign-physics5 if needed.)

Garden will stay on ign-cmake2 and soon will target ign-physics6 (main), so it's ok. We should still consider backporting the tutorial fixes for Citadel~Fortress in the future though.

@mabelzhang mabelzhang merged commit acf393d into main Dec 21, 2021
@mabelzhang mabelzhang deleted the mabelzhang/use_new_doxygen_filters branch December 21, 2021 04:10
@mabelzhang
Copy link
Contributor Author

Took a look at the version table. Making a note here. Since all of C-F use ign-cmake2, the only backporting needed would be #312 and this PR to ign-physics2 (Citadel), 4 (Edifice) if backporting prior to 2022-03, and 5 (Fortress).

mabelzhang added a commit that referenced this pull request Dec 21, 2021
@mabelzhang mabelzhang mentioned this pull request Dec 21, 2021
7 tasks
@chapulina
Copy link
Contributor

the only backporting needed would be #312 and this PR to ign-physics2 (Citadel), 4 (Edifice) if backporting prior to 2022-03, and 5 (Fortress).

Yup, for completeness, I'll just mention that a backport PR can be open for Citadel, and then Edifice and Fortress will get the fixes as Citadel is merged forward.

chapulina pushed a commit that referenced this pull request Jan 7, 2022
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