Document array messages in the Logger
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- php
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- No language data
- Stars
- 3
- Forks
- 1
- Avg merge
- 2m
- Merged PRs (30d)
- 26
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quantum-php/docs
-
documentation
Difficulty 3/5 1-2 days Newbie friendliness 74/100
quantum-php/docs#164 ·
Maintainers usually reply within 1 day
All issues in quantum-php/docs
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Could Have good first issue ui
Difficulty 1/5 Under an hour Newbie friendliness 85/100
hannahro15/Musical-Match-Saga#272 ·
Maintainers usually reply within 1 day
-
good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
dutchman-cad/dutchman#874 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 72/100
MUKE-coder/grit#243 ·