Document array messages in the Logger
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 72/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- php
- Bereich
- documentation
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 3
- Forks
- 1
- Ø Merge
- 2 Min.
- Gemergte PRs (30 T.)
- 26
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus quantum-php/docs
-
documentation
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 74/100
quantum-php/docs#164 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in quantum-php/docs
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 86/100
py-econometrics/pyfixest#2072 ·
Maintainer antworten meist innerhalb von 1 Tag
-
~planning docs
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Could Have good first issue ui
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
hannahro15/Musical-Match-Saga#272 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
dutchman-cad/dutchman#874 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 72/100
MUKE-coder/grit#243 ·