FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: deprecate Bicycle block's vlim/slim kwargs instead of erroring by petercorke · Pull Request #596 · petercorke/robotics-toolbox-python · GitHub

fix: deprecate Bicycle block's vlim/slim kwargs instead of erroring - #596

Merged
petercorke merged 2 commits into
mainfrom
fix/bicycle-block-deprecation
Aug 16, 2026
Merged

fix: deprecate Bicycle block's vlim/slim kwargs instead of erroring#596
petercorke merged 2 commits into
mainfrom
fix/bicycle-block-deprecation

Conversation

Copy link
Copy Markdown
Owner

Summary

  • The bdsim Bicycle block's vlim/slim kwargs were renamed to speed_max/steer_max in df5529f (2021) with no deprecation shim -- any diagram or script still using the old names hits an opaque BlockCreationError from bdsim's block-creation wrapper instead of a clear signal to update.
  • Restores the old kwargs as a deprecated alias: passing vlim/slim now emits a DeprecationWarning and maps onto speed_max/steer_max.
  • Found via RVC3-python's driveconfig.py (book Fig 4.14), which still used the pre-2021 kwargs and was failing outright.

Test plan

  • pytest tests/test_blocks.py tests/test_mobile.py -- 39 passed, 6 skipped
  • New test_bicycle_vlim_slim_deprecated asserts the warning fires and values map through correctly
  • Verified RVC3-python/RVC3/models/driveconfig.py runs end-to-end against this branch (previously failed with BlockCreationError)

vlim/slim were silently renamed to speed_max/steer_max in df5529f
(2021) with no back-compat shim, so any existing diagram or script
using the old names now hits an unexplained BlockCreationError
instead of a clear deprecation warning.

codecov Bot commented Aug 16, 2026
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 0.00%. Comparing base (47bc2cb) to head (1ee2c2e).

Files with missing lines Patch % Lines
src/roboticstoolbox/blocks/mobile.py 0.00% 9 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##            main    #596   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files        142     142           
  Lines      13882   13891    +9     
=====================================
- Misses     13882   13891    +9     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

petercorke merged commit 8f60b54 into main Aug 16, 2026
19 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant


Back | FazBrowse Home | New Git URL