#1819·penrose

feat: Better Function Documentation Strings

Author: KyleleeSeaCreated Jul 3, 2024Updated Jul 8, 2024
Labelskind:documentationkind:easy-change

Is your feature request related to a problem? Please describe. (From conversation with @joshsunshine) Some documentation strings are not informative. Namely, they do not explain how the function parameters relate to the functionality.

Example: shapeDistanceCircles - "Return the distance between two circles." does not explain usage of params c1, r1, c2, r2. Most of the shapeDistance___ functions suffer similarly in the expressiveness of the doc strings.

Additionally, some functions don't have documentation strings.

Additional Context The existing function info dicts include descriptions for each parameter. I've not included these in the shown autocomplete info since in many cases these descriptions are redundant (in equal, "x": "First value", "y": "Second value").

These objects are: compDict, constrDict, objDict found in penrose/core

Describe the solution you'd like Could go through each function doc string description and adjust them to be more informative.