UML class diagram of 'exception' is not rendered correctly on the deployed documentation

Đang mở
  • Có gì không ổn?
#3 1 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
8/100
Loại issue
Lỗi
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

The broken UML class diagram appears on two documentation pages, /home/exceptions/ and /api/basic_json/exception/, and the reporter says a local render is fine, so the fault is probably in how the docs are generated. This repository only holds the release scripts, so the generator is likely in the main nlohmann/json repository. Compare the generated page source against a local render to find where the diagram breaks. Done means the diagram renders on both deployed pages.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The UML class diagram shown on the following pages seems not rendered correctly:

A local render of the UML code seems ok, so I suspect something went wrong during the documentation generation. This is why I'm reporting this here rather then on the main repository.

Current display:
image
image

Local render:
image

Ngôn ngữ chính
Python
Star
6
Fork
1
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.