Inconsistencies between docs & integration test examples
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 55/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Compare the documentation examples with the integration test examples, starting with the user-defined axes page linked in the issue and its corresponding test example. Check both the code snippets and the identifiers used for examples and reference images. The synchronization is complete when the docs match the tested examples and the expected plots are picked up.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
With the refactor in #123 the associated bug fix PRs, there have been changes to the examples both in terms of the code snippets themselves and the ID used to tag them (usually a number perhaps with a letter prefix but not always). Therefore much of the docs examples are now out of date from what we test and generate the corresponding plots on. And some plots that should get embedded are not being picked up because the identifier in the reference image no longer matches that quoted (see e.g. https://ncas-cms.github.io/cf-plot/user_defined.html#example-21a-user-defined-axes).
They should be synchronised ASAP so the live docs are accurate.
Ideally we can go beyond that and draw both the docs and integration test code from the same source to ensure they remain in sync going forward too, but I am yet to decide the best solution to achieve this. So for the upcoming bug-fix release I will syncronise only. And later think of the long-term solution.
- Ngôn ngữ chính
- Python
- Star
- 21
- Fork
- 11
- Merge trung bình
- 2 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 7
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc 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 NCAS-CMS/cf-plot
-
docs enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
-
Add badges to READMEĐang mởdocs
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
dependencies infrastructure installation testing
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 78/100
-
testing
Độ khó 4/5 1-2 ngày Mức phù hợp với người mới 45/100
Tất cả issue của NCAS-CMS/cf-plot
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
FinanceFlash/unvibecode#509 ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
FAIRmat-NFDI/nomad-distro-dev#161 ·
-
bug v2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
modelcontextprotocol/python-sdk#3821 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug severity:low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Maintainer thường phản hồi trong vòng 2 ngày
-
Log-odds calibration uses upper middle score instead of median for even candidate setsCó thể đã có người làm @flysheep-ai đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày