Improve docstrings in moveit_py '.pyi' stubs for better usability

[VibhuSharma19]

docs(moveit_py): enhance .pyi stub files with detailed doc-strings

This commit improves the type stub files (.pyi) within the moveit_py package by adding comprehensive doc-strings 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 [email protected]

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:

• Purpose and usage of classes/interfaces
  

• Argument names, types, and descriptions
  

• Return value documentation
  

• Semantic clarity for developers and contributors
  

Motivation

This change is intended to:

• Enable rich IntelliSense/autocomplete in editors like VSCode 
  

• Serve as inline documentation for better onboarding and usage understanding
  

• Ensure the moveit_py Python interface is easier to use and maintain
  

Runtime Impact

No changes were made to runtime behavior.
This is a purely documentation-oriented update confined to .pyi files.

Checklist

• [ ] Required by CI: Code is auto formatted using clang-format
• [ ] Extend the tutorials / documentation reference
• [ ] Document API changes relevant to the user in the MIGRATION.md notes
• [ ] Create tests, which fail without this PR reference
• [ ] Include a screenshot if changing a GUI
• [ ] While waiting for someone to review your request, please help review another open pull request to support the maintainers

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 45.84%. Comparing base (89acadd) to head (1285d0a).

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     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[VibhuSharma19]

Hi, Kindly review and merge the changes at your earliest convenience. Let me know if any updates are needed. Thanks!

[github-actions[bot]]

This PR is stale because it has been open for 45 days with no activity. Please tag a maintainer for help on completing this PR, or close it if you think it has become obsolete.

[mergify[bot]]

This pull request is in conflict. Could you fix it @VibhuSharma19?

[github-actions[bot]]

This PR is stale because it has been open for 45 days with no activity. Please tag a maintainer for help on completing this PR, or close it if you think it has become obsolete.