Document array messages in the Logger
Maintainer thường phản hồi trong vòng 1 ngày
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
- 72/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- php
- Lĩnh vực
- documentation
Hướng nghiên cứu
Read the listed Logger and debugger pages, then check the released 3.2.0 code for the signatures and adapter behavior. Update the named pages and upgrade guide, keeping each fact on its home page and linking to it elsewhere. Verify examples against released code and check that internal links and anchors resolve.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Summary
Make the Logger pages match the behavior of quantum-php/framework#613, which lets logger() log an array message. It is in the 3.2.0 milestone because it changes the ReportableInterface contract.
Why
The Logger pages already promise that an array message is JSON-encoded with pretty printing, and that logger() is for structured array messages. In 3.1.x that call throws a TypeError. When #613 ships in 3.2.0, ReportableInterface::report() and the Logger methods accept string|Stringable|array, and each adapter renders the message, so the pages have to describe what really happens in each adapter and in the debugbar. A custom adapter has to widen its report() signature, which is a breaking change.
Pages
v3.0/packages/logger/usage.md: the "Log a structured payload" example, checked against the released code.v3.0/packages/logger/contracts.md: the new signature ofReportableInterface::report().v3.0/packages/logger/adapters.mdandarchitecture.md: how each adapter writes an array message, and what the debug-mode adapter keeps for the debugbar.v3.0/packages/logger/helpers.md: the signatures oferror(),warning(),notice(),info()anddebug(), which accept an array message too, and the two sentences that say the helpers take string messages only.v3.0/packages/debugger/architecture.md: how an array message appears in themessagestab, which is fed bylogger()->getAdapter()->getMessages().v3.0/upgrade-guide.md: a note for applications with a custom logger adapter, which must acceptstring|Stringable|array, and for applications that subclassLoggerand override a level method.
Acceptance criteria
- every name and example exists in the released code and was run
- each fact is stated once at its home page and linked elsewhere
- internal links and anchors resolve
- the pull request goes into
stagingand is published with the 3.2.0 documentation release
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 3
- Fork
- 1
- Merge trung bình
- 2 phút
- Pull request đã merge (30 ngày)
- 26
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 quantum-php/docs
-
documentation
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 74/100
quantum-php/docs#164 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của quantum-php/docs
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 86/100
py-econometrics/pyfixest#2072 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
~planning docs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Could Have good first issue ui
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
hannahro15/Musical-Match-Saga#272 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
good first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
dutchman-cad/dutchman#874 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
MUKE-coder/grit#243 ·