Repository navigation
docs: match :param names to the signatures in sensors and DHRobot - #906
Merged
Merged
Conversation
RangeBearingSensor.Hx, Hp and Hw document their landmark argument as `arg`, and DHRobot.config_validate documents `allowable`, but the parameters are `landmark` and `allowables`. Use the real names, and replace the `[description]` placeholder for `allowables`. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Owner
|
Thank you for your first contribution to RTB. Those |
petercorke
approved these changes
Nov 2, 2026
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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thanks for contributing to RTB!
Summary
Docstring fix only: four
:param:fields name arguments that the functions do not have.RangeBearingSensor.Hx,HpandHwdocument the landmark argument asarg; the parameter islandmark.DHRobot.config_validatedocumentsallowable; the parameter isallowables. Its description was the placeholder[description], now "one string of valid characters per choice, default first", which is what the method does (config_validate(config, ("lr", "ud", "nf"))inPuma560).This does not change numerical results or public behaviour.
Checked with an AST comparison of each
:paramname against the function signature (the four mismatches are gone) andruff check/ruff format --checkon both files (identical findings before and after, none on the changed lines).pytest,mypyand the Sphinx build were not run, since only docstrings change.This change was prepared with Claude Code (Claude Opus 5.5).
Related issue
None.
Checklist
Only the first item below is checked automatically — the rest are a self-check for you before requesting review, nothing currently verifies them for you.
type: description) — checked automatically, see the "Check PR title" statuspytest)X | Y,list[X], notUnion/Optional/List):param:,:returns:; type hints in the signature cover types now,:type:/:rtype:are rarely needed)assertin tests as "high" security), onlyAll tests passedand the PR title check are required — see CONTRIBUTING🤖 Generated with Claude Code