Skip to content

docs: fill documentation gaps found after the 3.1 changes - #149

Merged
armanist merged 2 commits into
stagingfrom
docs/3-1-small-gaps
Oct 23, 2026
Merged

armanist merged 2 commits into
stagingfrom
docs/3-1-small-gaps

Conversation

@armanist

Copy link
Copy Markdown
Collaborator

Fills documentation gaps found after the 3.1 changes (quantum-php/framework#585, #575, #599, #534, #566, #567).

What changed

  • packages/logger/contracts.md: the PSR-3 methods take string|Stringable $message, and a subclass that overrides them must declare the same type.
  • packages/ratelimit/adapters.md: the file adapter creates the missing parent folders of its path.
  • packages/console/built-in-commands.md: core:env looks for .env and .env.example in the project base directory, not in the folder the command runs from.
  • packages/httpclient/usage.md, overview.md, architecture.md, checked against real requests:
    • getErrors() also holds an entry for an HTTP 4xx or 5xx answer, not only for a cURL failure. The old text said the opposite.
    • how setData() is sent: JSON for a JSON content type, form-encoded for other arrays, multipart for a CURLFile, a string as it is
    • addGet() appends its data as a query string, and addPost() is shown
    • a JSON response body is decoded to an object, an XML body to a SimpleXMLElement
    • in async mode a failed request, 4xx and 5xx included, goes to the error callback, and the collector runs before the callbacks
    • request headers are read back in lowercase, and setHeaders() replaces the tracked set
    • the public accessors getMethod(), getData(), getAdapter(), isMultiRequest() and HttpClient::METHODS

Changed paths

  • v3.0/packages/logger/contracts.md
  • v3.0/packages/ratelimit/adapters.md
  • v3.0/packages/console/built-in-commands.md
  • v3.0/packages/httpclient/usage.md
  • v3.0/packages/httpclient/overview.md
  • v3.0/packages/httpclient/architecture.md

SUMMARY.md: no change.

@armanist
armanist merged commit bf6bbae into staging Oct 23, 2026
1 check passed
@armanist
armanist deleted the docs/3-1-small-gaps branch October 23, 2026 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant