Improve docstrings in moveit_py '.pyi' stubs for better usability #3424
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3424 +/- ##
==========================================
- Coverage 45.86% 45.84% -0.01%
==========================================
Files 717 717
Lines 62628 62628
Branches 7580 7580
==========================================
- Hits 28715 28705 -10
- Misses 33748 33756 +8
- Partials 165 167 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
VibhuSharma19
force-pushed
the
improved_docstring_moveitpy
branch
from
1285d0a to
3c27faa
Compare
rhaschke
reviewed
Apr 8, 2025
…sability docs(moveit_py): enhance .pyi stub files with detailed docstrings This commit improves the type stub files (.pyi) within the `moveit_py` package by adding comprehensive docstrings for all public classes, methods, and properties. The enhancements include: - Usage descriptions for classes and interfaces - Argument details with types and purpose - Return value descriptions - Improved clarity for users relying on static analysis tools (e.g. mypy, Pyright) - Better integration with editor IntelliSense and autocomplete features These changes aim to improve developer experience, maintainability, and usability of the Python interface of MoveIt. No changes were made to runtime behavior. Signed-off-by: Vibhu Sharma 1999vibhusharma@gmail.com
VibhuSharma19
force-pushed
the
improved_docstring_moveitpy
branch
from
814e105 to
5730ce7
Compare
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.
docs(moveit_py): enhance .pyi stub files with detailed doc-strings
This commit improves the type stub files (.pyi) within the
moveit_pypackage by adding comprehensive doc-strings for all public classes, methods, and properties. The enhancements include:These changes aim to improve developer experience, maintainability, and usability of the Python interface of MoveIt. No changes were made to runtime behavior.
Signed-off-by: Vibhu Sharma 1999vibhusharma@gmail.com
Description
This pull request enhances the type stub files (.pyi) in the moveit_py package by adding comprehensive and standardized doc-strings for all public-facing classes, methods, and properties.
These improvements provide detailed information such as:
Motivation
This change is intended to:
Runtime Impact
Checklist