prometheus / prometheus/client_python
enhancement: docstring to be RST friendly.
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 4.4k
- Fork
- 876
- Merge trung bình
- 8 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
This is probably not a bug, but I'm just wondering whether there is a decision not to make docstring for metrics RST-friendly.
Let's take the documentation for https://github.com/prometheus/client_python/blob/db391dbc83df4202698a21463ae89d6fb3611ce2/prometheus_client/metrics.py#L516 as an example.
The code block will not be rendered as a code block but as a quotes block when using Sphinx.
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
Bắt đầu với docstring của Metrics trong prometheus_client/metrics.py, quanh dòng 516, và render tài liệu của nó bằng Sphinx để tái hiện vấn đề định dạng. Hoàn tất khi các docstring Metrics liên quan render các ví dụ mã của chúng dưới dạng các khối mã RST thay vì các khối trích dẫn.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- 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
- 35/100