compas-dev / compas-dev/compas_fab
documentation of functions' return value
Open
- Dominant language
- Python
- Stars
- 137
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
The current documentation of functions misses explanations of the return values.
For instance, the one here:
https://gramaziokohler.github.io/compas_fab/latest/reference/generated/compas_fab.robots.Robot.plan_cartesian_motion.html?highlight=plan_cartesian_motion#compas_fab.robots.Robot.plan_cartesian_motion
Operating System name and version, Python version, etc.
Contributor guide
Assessment
This issue has not been assessed yet.