Skip to content

Commit 854074c

Browse files
committed
Improve some tag formatting
1 parent 787b486 commit 854074c

19 files changed

Lines changed: 34 additions & 36 deletions

docs/Writerside/topics/phpdoc/tags/category-tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ module, `@category` places that module within a wider organizational scheme.
2424
> With additional context about the grouping.
2525
> ```php
2626
> /**
27-
> * @category Database Drivers and connection pooling for
28-
> * relational stores.
27+
> * @category Database Drivers and connection pooling for relational
28+
> * stores.
2929
> */
3030
> ```
3131

docs/Writerside/topics/phpdoc/tags/example-tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ reused across several tags that each highlight a different part of it.
2626
> Narrowed to the lines that show the relevant usage.
2727
> ```php
2828
> /**
29-
> * @example docs/examples/mailer-retry.php 12 8 Configuring a
30-
> * retry policy.
29+
> * @example docs/examples/mailer-retry.php 12 8 Configuring a retry
30+
> * policy.
3131
> */
3232
> public function withRetries(int $attempts): static
3333
> ```

docs/Writerside/topics/phpdoc/tags/link-tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ be a well-formed URI, never a class, method, or constant reference.
2525
> relevant.
2626
> ```php
2727
> /**
28-
> * @link https://example.com/docs/rate-limits
29-
> * Applies to all public endpoints.
28+
> * @link https://example.com/docs/rate-limits Applies to all public
29+
> * endpoints.
3030
> */
3131
> ```
3232

docs/Writerside/topics/phpdoc/tags/no-named-arguments-tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ stays free to rename parameters without it counting as a break.
2727
> With a description explaining why.
2828
> ```php
2929
> /**
30-
> * @no-named-arguments Parameter names will
31-
> * change once the driver abstraction lands.
30+
> * @no-named-arguments Parameter names will change once the driver
31+
> * abstraction lands.
3232
> */
3333
> function connect(string $dsn, ?string $user, ?string $password): PDO
3434
> ```

docs/Writerside/topics/phpdoc/tags/override-tag.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ attribute has no effect.
2525
> implementation.
2626
> ```php
2727
> /**
28-
> * @override Adds retry handling on top of the
29-
> * base transport.
28+
> * @override Adds retry handling on top of the base transport.
3029
> */
3130
> public function send(Message $message): bool
3231
> ```

docs/Writerside/topics/phpdoc/tags/param-closure-this-tag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ closure that reads `$this` has no documented type to check against.
2828
> ```php
2929
> /**
3030
> * @param Closure(int): void $callback
31-
> * @param-closure-this Connection $callback
32-
> * Bound before dispatch so the callback can
33-
> * reach the connection's protected members.
31+
> * @param-closure-this Connection $callback Bound before dispatch so
32+
> * the callback can reach the connection's
33+
> * protected members.
3434
> */
3535
> function onConnect(Closure $callback): void
3636
> ```

docs/Writerside/topics/phpdoc/tags/param-immediately-invoked-callable-tag.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ callable might be kept and invoked at some unrelated point in time.
2929
> With a description explaining why it matters here.
3030
> ```php
3131
> /**
32-
> * @param-immediately-invoked-callable $callback
33-
> * Runs before the lock is released, so it can
34-
> * safely mutate the shared buffer.
32+
> * @param-immediately-invoked-callable $callback Runs before the
33+
> * lock is released, so it can
34+
> * safely mutate the shared
35+
> * buffer.
3536
> */
3637
> function withLock(callable $callback): mixed
3738
> ```

docs/Writerside/topics/phpdoc/tags/param-later-invoked-callable-tag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ be assumed pure just because the callback itself might be.
3131
> With a description explaining when it actually runs.
3232
> ```php
3333
> /**
34-
> * @param-later-invoked-callable $callback
35-
> * Invoked once the response arrives, which
36-
> * may be long after this method returns.
34+
> * @param-later-invoked-callable $callback Invoked once the response
35+
> * arrives, which may be long after
36+
> * this method returns.
3737
> */
3838
> function then(callable $callback): static
3939
> ```

docs/Writerside/topics/phpdoc/tags/param-out-tag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ analyzers are stuck assuming the same type applies in both directions.
3131
> /**
3232
> * @param list<int> $matches
3333
> * @param-out non-empty-list<int> $matches Populated only when the
34-
> * function returns true.
34+
> * function returns true.
3535
> */
3636
> function findAll(string $pattern, array &$matches): bool
3737
> ```

docs/Writerside/topics/phpdoc/tags/property-read-tag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ accidental assignment to a value that the class was never meant to accept.
2828
> ```php
2929
> /**
3030
> * @property-read DateTimeImmutable $createdAt When the record was
31-
> * inserted.
31+
> * inserted.
3232
> */
3333
> class Record {}
3434
> ```

0 commit comments

Comments
 (0)