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

Feature/doc warning fix #438

Merged
merged 4 commits into from
Oct 8, 2023
Merged

Feature/doc warning fix #438

merged 4 commits into from
Oct 8, 2023

Conversation

schaubh
Copy link
Contributor

@schaubh schaubh commented Sep 20, 2023

  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

The BSK documentation build process had a few new doxygen warnings at the very beginning of the build process. These are now fixed in this pull request.

Verification

Did a clean build of the documentation and no warnings were present.

Documentation

N/A

Future work

Be sure to keep checking the full RST documentation build process log for warnings.

@schaubh schaubh added the documentation Improvements or additions to documentation label Sep 20, 2023
@schaubh schaubh self-assigned this Sep 20, 2023
Copy link
Contributor

@joaogvcarneiro joaogvcarneiro left a comment

Choose a reason for hiding this comment

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

Looks good. However, please note that commits 2-4 have commit messages that are too long and are being chopped off.

The warning is about the method documentation having
arguments that are no longer present
The capitalization of
currentSimNanos changed in the method, but not the method
documentation.
This feature is now already in BSK
@schaubh schaubh merged commit 31bfe00 into develop Oct 8, 2023
2 checks passed
@schaubh schaubh deleted the feature/doc_warning_fix branch October 8, 2023 15:55
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
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants