Document array messages in the Logger
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 72/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- php
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 3
- Forks
- 1
- Merge medio
- 2 min
- PR fusionados (30 d)
- 26
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de quantum-php/docs
-
documentation
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
quantum-php/docs#164 ·
Los mantenedores suelen responder en 1 día
Todos los issues de quantum-php/docs
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 86/100
py-econometrics/pyfixest#2072 ·
Los mantenedores suelen responder en 1 día
-
~planning docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
Kromatic-Innovation/athenaeum#3084 ·
Los mantenedores suelen responder en 1 día
-
Could Have good first issue ui
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
hannahro15/Musical-Match-Saga#272 ·
Los mantenedores suelen responder en 1 día
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
dutchman-cad/dutchman#874 ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
MUKE-coder/grit#243 ·