Skip to content

docs(ets): add fixjoint examples and version markers - #877

Merged
petercorke merged 3 commits into
petercorke:mainfrom
huxiaoyi-ovo:docs/fixjoint-examples-825
Oct 22, 2026
Merged

petercorke merged 3 commits into
petercorke:mainfrom
huxiaoyi-ovo:docs/fixjoint-examples-825

Conversation

@huxiaoyi-ovo

Copy link
Copy Markdown
Contributor

Summary

Part of #825 — documentation follow-up only.

  • Add a runnable ETS.fixjoint() example demonstrating a flipped rotational joint fixed in degrees.
  • Show how to lock a joint in a Panda robot's ETS.
  • Add a corresponding ETS2.fixjoint() example for planar robots.
  • Add .. versionadded:: 1.5.0 to both method docstrings.

This PR changes documentation only. It does not modify numerical behaviour or public APIs.

The boolean-index validation work is handled separately in #836.

Validation

Full fork CI passed: https://github.com/huxiaoyi-ovo/robotics-toolbox-python/actions/runs/39573005661

  • All Linux, Windows and macOS tests passed on Python 3.10–3.14.
  • Core tests and mypy passed.
  • Coverage and Sphinx documentation build passed.
  • Changes are limited to two files with 29 added lines.

AI Assistance

ChatGPT (OpenAI GPT-6) assisted with the documentation examples. The changes and CI results were reviewed before submission.

huxiaoyi-ovo and others added 2 commits October 21, 2026 04:53
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.

@codecov

codecov Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (ff0e902) to head (e67482d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #877   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files        146     146           
  Lines      17168   17168           
=====================================
  Misses     17168   17168           

☔ 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

Copy link
Copy Markdown
Owner

Thank you for these examples. They show a flipped joint being fixed in degrees and what is left as a variable, which the docstring lacked, and the version markers are right. I'll update the branch with main and merge it once CI is green.

@petercorke
petercorke enabled auto-merge (squash) October 22, 2026 01:34
@petercorke
petercorke merged commit 093a760 into petercorke:main Oct 22, 2026
23 checks passed
@github-actions github-actions Bot mentioned this pull request Oct 22, 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