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.

Sign up for GitHub

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

Jump to bottom

Improve JumpThreshold documentation and forbid zero durations #861

Merged

sloretz merged 2 commits into master from jump_threshold_documentation

Dec 10, 2021

Contributor

sloretz commented Dec 9, 2021 •

edited

Split from #858

This documents JumpThreshold, and forbids passing zero Durations.

JumpThreshold min_forward and min_backward are disabled in rclpy when None is passed. In rcl the thresholds are disabled when set to 0. I chose to make JumpThreshold forbid zero Durations so that there's only one way to disable them. Otherwise, it's easy to pass a zero duration and think it's requesting the smallest possible time jump.


          Improve JumpThreshold documentation and forbid zero durations

b03ba27

Signed-off-by: Shane Loretz <sloretz@openrobotics.org>

sloretz self-assigned this

j-rivero approved these changes

View reviewed changes

Contributor Author

sloretz commented Dec 10, 2021

CI (build: --packages-up-to rclpy test: --packages-select rclpy)

Linux
Linux-aarch64
macOS
Windows


          Blank link between summary and description

a04bee4

Signed-off-by: Shane Loretz <sloretz@openrobotics.org>

Contributor Author

sloretz commented Dec 10, 2021 •

edited

Rerun of CI with linter fix

Linux
Linux-aarch64
macOS
- CI infrastructure issue, rerun:
Windows

Contributor Author

sloretz commented Dec 10, 2021

Since the commit a04bee4 is only adding a newline in a docstring to satisfy the linter, I'll assume @j-rivero 's approval still applies.

sloretz merged commit 0582aaf into master

delete-merged-branch bot deleted the jump_threshold_documentation branch

December 10, 2021 01:25

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment