From 1ffce63394790466f990634e839f63114ee5173d Mon Sep 17 00:00:00 2001 From: Jesse Donat Date: Tue, 6 Oct 2026 17:07:00 -0500 Subject: [PATCH 1/3] Update donatj/mddoc dependency version to ^0.13.0 --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 766ae25..d86cd5a 100644 --- a/composer.json +++ b/composer.json @@ -18,7 +18,7 @@ "php": "^7.4|^8.0" }, "require-dev": { - "donatj/mddoc": "^0.11.1", + "donatj/mddoc": "^0.13.0", "phpstan/phpstan": "^2.2", "phpunit/phpunit": "^9.6" }, From 8bd8a83b42542eca6ec44d187a70a20a5fb6b8d9 Mon Sep 17 00:00:00 2001 From: Jesse Donat Date: Tue, 6 Oct 2026 17:08:02 -0500 Subject: [PATCH 2/3] Add documentation verification step to CI workflow --- .github/workflows/ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 206a28e..600d166 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -32,3 +32,6 @@ jobs: - name: Run tests run: vendor/bin/phpstan + + - name: Verify documentation + run: ./vendor/bin/mddoc --dry-run=true From 5078421cfe1799c5de94a28e1959b8a30329fad3 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 6 Oct 2026 22:10:13 +0000 Subject: [PATCH 3/3] Regenerate README with mddoc 0.13.0 Co-authored-by: donatj <133747+donatj@users.noreply.github.com> --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 11c53ae..ed00f30 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,15 @@ composer require 'quorum/stream-functions' ### Function: \Quorum\Streams\faccept ```php -function faccept($stream, string ...$accept) : ?string +function faccept($stream, string ...$accept): ?string ``` -##### Parameters: +##### Parameters - ***resource*** `$stream` - The stream to peek, must be a seekable resource - ***string*** `$accept` - One or more strings to accept -##### Returns: +##### Return Value - ***string*** | ***null*** - The accepted string or null if none were found @@ -47,15 +47,15 @@ If the string is not found, the cursor is reset to its original position. ### Function: \Quorum\Streams\fpeek ```php -function fpeek($stream [, int $length = 1]) : string +function fpeek($stream, int $length = 1): string ``` -##### Parameters: +##### Parameters - ***resource*** `$stream` - The stream to peek, must be a seekable resource - ***positive-int*** `$length` - Up to length number of bytes read. -##### Returns: +##### Return Value - ***string*** - The peeked string of up to length bytes @@ -66,17 +66,22 @@ The cursor is reset to its original position. ### Function: \Quorum\Streams\funtil ```php -function funtil($stream, string $until [, int $length = 0 [, ?string $buf = null]]) : bool +function funtil( + $stream, + string $until, + int $length = 0, + ?string $buf = null, +): bool ``` -##### Parameters: +##### Parameters - ***resource*** `$stream` - The stream to read, must be a seekable resource - ***string*** `$until` - The string to read until - ***non-negative-int*** `$length` - The maximum number of bytes to read, defaults to 0 (no limit) - ***string*** | ***null*** `$buf` - The buffered contents by reference -##### Returns: +##### Return Value - ***bool***