Full python docstring not included in web API docs
Đang mở
@LiamConnors đang làm issue này rồi.
Từ ngày 11/7/2024.
bug
documentation
P3
- Ngôn ngữ chính
- Python
- Star
- 18.8k
- Fork
- 2.8k
- Merge trung bình
- 16 giờ 26 phút
- Pull request đã merge (30 ngày)
- 21
Mô tả
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
"""
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Đánh giá
Issue này chưa được đánh giá.