Full python docstring not included in web API docs
未关闭
@LiamConnors 已经在做这个了。
开始于 2024年7月11日。
bug
documentation
P3
- 主要语言
- Python
- 星标
- 18.8k
- 派生
- 2.8k
- 平均合并
- 16 小时 26 分钟
- 30 天内合并 PR
- 21
描述
It looks like only the first section in the python docstring is included in the API docs?
If you look at the documentation for e.g. Cone:
anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.
(This is nonsense: What is "cm"? What is the datatype and allowed input for anchor?)
But cone.py contains a docstring with more content:
def anchor(self):
"""
Sets the cones' anchor with respect to their x/y/z positions.
Note that "cm" denote the cone's center of mass which
corresponds to 1/4 from the tail to tip.
The 'anchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['tip', 'tail', 'cm', 'center']
Returns
-------
Any
"""
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
评估
这个 Issue 还没有评估数据。