Deprecated parameter handling
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
- 35/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- 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 cách theo dõi cách parser xử lý các mục @param, sử dụng ví dụ get_the_author và mẫu tham số Deprecated được ghi lại trong tài liệu làm điểm bắt đầu. Xem lại phần thảo luận của issue để xác định cách diễn đạt hướng đến người dùng; công việc được xem là hoàn tất khi các tham số đã deprecated không được phân loại là Required và được trình bày một cách riêng biệt, không ngụ ý rằng toàn bộ hàm đã deprecated.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Per now the devhub doesn't play well with deprecated parameters for function calls, an example of this would be the get_the_author function which used to have a parameter.
The parser currently picks these up as Required, which is a little bit unlucky.
Deprecated parameters seem to consistently be defined with @param $var Deprecated, so detecting these shouldn't be an issue, but how should we relay that to the user in a clear manner, and in such a way that it doesn't accidentally get read as the whole function being deprecated which the current use of $deprecated as the parameter name might lead to.
- Ngôn ngữ chính
- PHP
- Star
- 239
- Fork
- 81
- Merge trung bình
- 1 ngày 11 giờ
- Pull request đã merge (30 ngày)
- 3
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
- Đọ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 WordPress/phpdoc-parser
-
Adopt PHPStan for typesCó thể đã có người làm @sirreal đã nhận 7 ngày trước. Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
WordPress/phpdoc-parser#304 · 1 reaction ·
-
Include constants in exportsĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
WordPress/phpdoc-parser#269 ·
-
Nested union types inside generics are split incorrectlyCó thể đã có người làm @sirreal đã nhận 81 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 64/100
WordPress/phpdoc-parser#268 · 2 bình luận ·
-
Some characters are stripped from documentationCó thể đã có người làm @sirreal đã nhận 82 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
WordPress/phpdoc-parser#254 ·
-
Compatibility updates requiredĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
WordPress/phpdoc-parser#246 · 9 bình luận ·
Tất cả issue của WordPress/phpdoc-parser
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
matomo-org/device-detector#8405 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 1 ngày
-
sync-en
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày
-
sync-en
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
Maintainer thường phản hồi trong vòng 4 ngày