Skip to content

docs(robot): fix BaseRobot reST return and parameter fields - #905

Merged
petercorke merged 3 commits into
petercorke:mainfrom
huxiaoyi-ovo:docs/robot-docstring-fields-574
Nov 2, 2026
Merged

petercorke merged 3 commits into
petercorke:mainfrom
huxiaoyi-ovo:docs/robot-docstring-fields-574

Conversation

@huxiaoyi-ovo

Copy link
Copy Markdown
Contributor

Summary

Fixes several malformed and duplicated docstring fields in BaseRobot.py, following up on #574.

The changes are limited to documentation:

  • Consolidated repeated :returns: fields in hascollision(), get_path(), _get_limit_links(), and todegrees().
  • Fixed malformed :param :param directives in ets().
  • Corrected the return description of get_path(): it returns the number of links in the path, not the number of joints.
  • Replaced the old-style parameter and exception descriptions in _get_limit_links() with proper reST fields.

No runtime logic or public API changes.

Validation

Closes the BaseRobot docstring cleanup item in #574.

AI assistance: ChatGPT (GPT-6) helped review the docstrings and prepare the changes.

huxiaoyi-ovo and others added 2 commits October 27, 2026 03:54
Co-Authored-By: ChatGPT (OpenAI GPT-6) <noreply@openai.com>
Co-Authored-By: ChatGPT (OpenAI GPT-6) <noreply@openai.com>
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results
Complexity 0
Duplication 0

View in Codacy

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.

@petercorke

Copy link
Copy Markdown
Owner

Thank you for the cleanup, and for checking the get_path() return: the old text said joints but it is the number of links. Looks good to me.

@petercorke
petercorke merged commit 454c69e into petercorke:main Nov 2, 2026
24 checks passed
@github-actions github-actions Bot mentioned this pull request Nov 2, 2026
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.

2 participants