cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- PHP
- Star
- 29
- Fork
- 15
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Description
Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?
CakePHP Version
4.4.0
PHP Version
No response
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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
So sánh trang API được tạo cho RecordNotFoundException với tham chiếu nguồn trong CakeException.php, đặc biệt là phần văn bản {@link \Cake\Http\Response::withHeader()}. Truy vết docs builder hoặc link generator chịu trách nhiệm chuyển đổi các tham chiếu này, sau đó xác minh rằng tài liệu API được tạo hiển thị chúng dưới dạng siêu liên kết thay vì các chuỗi thô.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- php
- Lĩnh vực
- documentation
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 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
- 45/100