Document array messages in the Logger

オープン
#155 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
php
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

documentation

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 of ReportableInterface::report().
  • v3.0/packages/logger/adapters.md and architecture.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 of error(), warning(), notice(), info() and debug(), 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 the messages tab, which is fed by logger()->getAdapter()->getMessages().
  • v3.0/upgrade-guide.md: a note for applications with a custom logger adapter, which must accept string|Stringable|array, and for applications that subclass Logger and 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 staging and is published with the 3.2.0 documentation release
主要言語
言語のデータがありません
スター
3
フォーク
1
平均マージ
2分
マージ済み PR(30日)
26

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

quantum-php/docs のほかの issue

quantum-php/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。