Document array messages in the Logger
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 72/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- php
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 3
- Forks
- 1
- Merge médio
- 2min
- PRs com merge (30d)
- 26
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de quantum-php/docs
-
documentation
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 74/100
quantum-php/docs#164 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de quantum-php/docs
Issues semelhantes
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 86/100
py-econometrics/pyfixest#2072 ·
Mantenedores costumam responder em até 1 dia
-
~planning docs
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
Kromatic-Innovation/athenaeum#3084 ·
Mantenedores costumam responder em até 1 dia
-
Could Have good first issue ui
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
hannahro15/Musical-Match-Saga#272 ·
Mantenedores costumam responder em até 1 dia
-
good first issue help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
dutchman-cad/dutchman#874 ·
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
MUKE-coder/grit#243 ·