Typing

[liquidcronos]

Added type hints and fixed the docstrings

Description

The docstrings are deprecated or incomplete. This pull request fixes them. It also consistently adds type hints for easier development

Motivation and Context

This change is required to make the package usable for other developers. The docstrings help make the documentation better and the typing hints help developers with the proper IDEs to better understand function inputs.

How has this been tested?

Since this test adds no functional features it did not need any tests

Screenshots (if appropriate):

Types of changes

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• [x] My code follows the code style of this project.
• [ ] My change requires a change to the documentation.
• [ ] I have updated the documentation accordingly.

[codecov[bot]]

Codecov Report

Merging #26 (169c0b7) into main (8751461) will increase coverage by 0.42%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
+ Coverage   80.00%   80.42%   +0.42%     
==========================================
  Files          12       12              
  Lines         600      608       +8     
==========================================
+ Hits          480      489       +9     
+ Misses        120      119       -1     

Impacted Files	Coverage Δ
src/pybullet_industrial/endeffector_tool.py	81.70% <100.00%> (ø)
src/pybullet_industrial/extruder.py	100.00% <100.00%> (ø)
src/pybullet_industrial/interpolation.py	74.50% <100.00%> (+1.43%)	:arrow_up:
src/pybullet_industrial/material.py	88.88% <100.00%> (+0.10%)	:arrow_up:
src/pybullet_industrial/path_builders.py	100.00% <100.00%> (ø)
src/pybullet_industrial/raycaster.py	94.44% <100.00%> (+0.15%)	:arrow_up:
src/pybullet_industrial/remover.py	100.00% <100.00%> (ø)
src/pybullet_industrial/robot_base.py	88.04% <100.00%> (ø)
src/pybullet_industrial/sensors.py	97.50% <100.00%> (+0.13%)	:arrow_up:
src/pybullet_industrial/toolpath.py	74.57% <100.00%> (ø)
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 8751461...169c0b7. Read the comment docs.