enhancement: docstring to be RST friendly.

Đang mở

#848 mở ngày 23/10/2022 5 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó: 2/5
Thời gian dự kiến: 1-3 giờ
Mức phù hợp với người mới: 35/100

Loại issue: Tài liệu
Độ rõ ràng: Khá rõ ràng
Mức độ hoạt động: Đình trệ
Công nghệ: python
Lĩnh vực: documentation

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.

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.

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

Hướng dẫn đóng góp

Mở 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.

Issue khác của prometheus/client_python

OpenMetrics content negotiation: `escaping=underscores` causes name mismatch between `HELP/TYPE` metadata and sample lines for metrics with colons Đang mở

bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100

prometheus/client_python#1177 · 1 bình luận · Mở ngày 15/5/2026
Support OpenMetrics 2.0 exposition format Đang mở

Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100

prometheus/client_python#1210 · Mở ngày 23/9/2026
MultiProcessCollector fails permanently on an empty metrics file left by a killed worker Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 58/100

prometheus/client_python#1199 · 1 reaction · Mở ngày 12/8/2026
feature request/RFC: leave out a label (from at least `*MetricFamily` samples) when it's value is set to `None` Đang mở

Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100

prometheus/client_python#1176 · Mở ngày 14/5/2026
WSL and MultiProcessCollector Đang mở

Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 52/100

prometheus/client_python#1126 · 2 bình luận · Mở ngày 29/8/2025

Tất cả issue của prometheus/client_python

Issue tương tự

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache Đang mở

bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

stephrobert/dsoxlab#238 · Mở ngày 24/9/2026
Uniform probability densities use the upper bound as an interval width Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

nasa/fmdtools#40 · Mở ngày 24/9/2026
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

sublimehq/package_control#1780 · Mở ngày 24/9/2026
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100

pcdshub/mfx#309 · 2 bình luận · Mở ngày 24/9/2026
niri config file addition does not respect existing optional include Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100

nwg-piotr/nwg-displays#145 · Mở ngày 24/9/2026

Thêm issue về Python