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

Update documentation on UpdateInfo::realTime #1817

Merged
merged 1 commit into from
Nov 28, 2022

Conversation

azeey
Copy link
Contributor

@azeey azeey commented Nov 28, 2022

🦟 Bug fix

Fixes #1777

Summary

The documentation for UpdateInfo::realTime says the value would increase even if simulation is paused. This is definitely not the case as can be seen from the code

// Keep track of wall clock time. Only start the realTimeWatch if this
// runner is not paused.
if (!this->currentInfo.paused)
this->realTimeWatch.Start();

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • 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.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@azeey azeey merged commit ebbe181 into gazebosim:ign-gazebo3 Nov 28, 2022
@azeey azeey deleted the doc/realTime branch November 28, 2022 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants