[mkdocs] return type format in plotly.figure_factory functions
Đang mở
Chưa có ai nhận issue này.
documentation
P2
- 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ả
- After converting the docstrings of each function into numpy style, the return types are not as clear and might want to be edited for clarity. For example, the following return type for
create_facet_grid:
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.
Hướng nghiên cứu
Rà soát các docstring theo kiểu NumPy cho các hàm của plotly.figure_factory, bắt đầu với ví dụ về kiểu trả về của create_facet_grid trong issue. Làm rõ các kiểu trả về một cách nhất quán trên các hàm bị ảnh hưởng, trong đó việc hoàn tất được thể hiện bằng tài liệu rõ ràng cho từng giá trị trả về.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 38/100