cake 5: Support parameters with only type hints

Đang mở
#198 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét cách các tham số CakePHP 5 có type hint của PHP 8 được biểu diễn trong tài liệu API. Xác định xem các tham số không có chú thích @param tương ứng nên xuất hiện với mô tả trống hay bị ẩn, sau đó bổ sung coverage cho hành vi đã chọn.

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

Mô tả

Starting with cake 5, some function parameters won't have matching docblock @param annotations.

Do we want to still list these parameters in the parameter block with no description or should we hide them?

image

These parameters won't have a matching annotation because PHP 8 allows union types that fully documents the allowed types and the parameter name is self-documenting (the annotation description isn't helpful).

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

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.

Issue khác của cakephp/cakephp-api-docs

Tất cả issue của cakephp/cakephp-api-docs

Issue tương tự

Thêm issue về PHP

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.