cakephp / cakephp/cakephp-api-docs

Web site API reference lacks extended class and implemented interfaces...

Đang mở
#338 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

enhancement
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

I feel strange because I can't believe I can't find it...

I pick up just an example. I was trying to understand what Cake\ORM\ResultSet actually is. Easy to guess by the scope and the name (and the methods). But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations. For CakePHP I have to open the source code link.

Example: Cake\ORM\ResultSet.

CakePHP Version

5.2

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

  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.

Hướng nghiên cứu

Bắt đầu với trang tham chiếu API Cake\ORM\ResultSet được liên kết trong issue và so sánh trang này với mã nguồn được liên kết. Truy theo cách tạo tham chiếu API, sau đó đảm bảo lớp được mở rộng và các interface được triển khai được hiển thị trên trang, rồi kiểm tra đầu ra được tạo.

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
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 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
35/100

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.