#1819·penrose

feat: 更好的函数文档字符串

作者: KyleleeSea创建于 2024年7月3日更新于 2024年7月8日
标签kind:documentationkind:easy-change

**您的功能请求是否与问题有关?请描述。** (来自与 @joshsunshine 的对话) 一些文档字符串不具备信息性。具体而言,它们没有解释函数参数与功能的关系。 例如,shapeDistanceCircles - "返回两个圆之间的距离" 并没有解释 c1、r1、c2、r2 这些参数的用法。 大多数 shapeDistance___ 函数的文档字符串表达力也类似。 此外,有些函数没有文档字符串。

内容来源: penrose/penrose