Skip to content

Commit 05e4986

Browse files
committed
Fix @return PHPDoc in all traits: change self|FluentAssertions to self
1 parent c6c918f commit 05e4986

File tree

8 files changed

+128
-104
lines changed

8 files changed

+128
-104
lines changed

src/Traits/ArrayAssertions.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ trait ArrayAssertions
2424
* @param int $expectedCount The expected number of elements.
2525
* @param string $message Optional custom error message.
2626
*
27-
* @return self|FluentAssertions Returns the FluentAssertions instance for method chaining.
27+
* @return self Enables fluent chaining of assertion methods.
2828
*/
2929
public function count(int $expectedCount, string $message = ''): self
3030
{
@@ -45,7 +45,7 @@ public function count(int $expectedCount, string $message = ''): self
4545
* @param int $elementsCount The number of elements that should not match.
4646
* @param string $message Optional custom error message.
4747
*
48-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
48+
* @return self Enables fluent chaining of assertion methods.
4949
*/
5050
public function notCount(int $elementsCount, string $message = ''): self
5151
{
@@ -65,7 +65,7 @@ public function notCount(int $elementsCount, string $message = ''): self
6565
*
6666
* @param array $values The associative array that should be contained within the actual array.
6767
*
68-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
68+
* @return self Enables fluent chaining of assertion methods.
6969
*/
7070
public function arrayContainsAssociativeArray(array $values): self
7171
{
@@ -108,7 +108,7 @@ protected function arrayContainsAssociativeArrayRecursive(array $data, array $va
108108
* @param int|string $key The key to check for existence.
109109
* @param string $message Optional custom error message.
110110
*
111-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
111+
* @return self Enables fluent chaining of assertion methods.
112112
*/
113113
public function arrayHasKey(int|string $key, string $message = ''): self
114114
{
@@ -129,7 +129,7 @@ public function arrayHasKey(int|string $key, string $message = ''): self
129129
* @param int|string $key The key that should not exist.
130130
* @param string $message Optional custom error message.
131131
*
132-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
132+
* @return self Enables fluent chaining of assertion methods.
133133
*/
134134
public function arrayNotHasKey(int|string $key, string $message = ''): self
135135
{
@@ -150,7 +150,7 @@ public function arrayNotHasKey(int|string $key, string $message = ''): self
150150
* @param mixed $value The value to check for.
151151
* @param string $message Optional custom error message.
152152
*
153-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
153+
* @return self Enables fluent chaining of assertion methods.
154154
*/
155155
public function contains(mixed $value, string $message = ''): self
156156
{
@@ -171,7 +171,7 @@ public function contains(mixed $value, string $message = ''): self
171171
* @param mixed $value The value that should not be present.
172172
* @param string $message Optional custom error message.
173173
*
174-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
174+
* @return self Enables fluent chaining of assertion methods.
175175
*/
176176
public function doesNotContain(mixed $value, string $message = ''): self
177177
{
@@ -192,7 +192,7 @@ public function doesNotContain(mixed $value, string $message = ''): self
192192
* @param int $size The expected size.
193193
* @param string $message Optional custom error message.
194194
*
195-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
195+
* @return self Enables fluent chaining of assertion methods.
196196
*/
197197
public function hasSize(int $size, string $message = ''): self
198198
{
@@ -212,7 +212,7 @@ public function hasSize(int $size, string $message = ''): self
212212
*
213213
* @param string $message Optional custom error message.
214214
*
215-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
215+
* @return self Enables fluent chaining of assertion methods.
216216
*/
217217
public function isEmptyArray(string $message = ''): self
218218
{
@@ -232,7 +232,7 @@ public function isEmptyArray(string $message = ''): self
232232
*
233233
* @param string $message Optional custom error message.
234234
*
235-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
235+
* @return self Enables fluent chaining of assertion methods.
236236
*/
237237
public function isNotEmptyArray(string $message = ''): self
238238
{

src/Traits/BooleanAssertions.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ trait BooleanAssertions
2424
*
2525
* @param string $message Optional custom error message.
2626
*
27-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
27+
* @return self Enables fluent chaining of assertion methods.
2828
*/
2929
public function true(string $message = ''): self
3030
{
@@ -45,7 +45,7 @@ public function true(string $message = ''): self
4545
*
4646
* @param string $message Optional custom error message.
4747
*
48-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
48+
* @return self Enables fluent chaining of assertion methods.
4949
*/
5050
public function notTrue(string $message = ''): self
5151
{
@@ -66,7 +66,7 @@ public function notTrue(string $message = ''): self
6666
*
6767
* @param string $message Optional custom error message.
6868
*
69-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
69+
* @return self Enables fluent chaining of assertion methods.
7070
*/
7171
public function false(string $message = ''): self
7272
{
@@ -87,7 +87,7 @@ public function false(string $message = ''): self
8787
*
8888
* @param string $message Optional custom error message.
8989
*
90-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
90+
* @return self Enables fluent chaining of assertion methods.
9191
*/
9292
public function notFalse(string $message = ''): self
9393
{

src/Traits/ComparisonAndEqualityAssertions.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ trait ComparisonAndEqualityAssertions
2525
* @param mixed $expected The expected value to compare against.
2626
* @param string $message Optional custom error message.
2727
*
28-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
28+
* @return self Enables fluent chaining of assertion methods.
2929
*/
3030
public function is(mixed $expected, string $message = ''): self
3131
{
@@ -46,7 +46,7 @@ public function is(mixed $expected, string $message = ''): self
4646
* @param mixed $expected The expected value to compare against.
4747
* @param string $message Optional custom error message.
4848
*
49-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
49+
* @return self Enables fluent chaining of assertion methods.
5050
*/
5151
public function equals(mixed $expected, string $message = ''): self
5252
{
@@ -68,7 +68,7 @@ public function equals(mixed $expected, string $message = ''): self
6868
* @param mixed $expected The value that the actual value should not be.
6969
* @param string $message Optional custom error message.
7070
*
71-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
71+
* @return self Enables fluent chaining of assertion methods.
7272
*/
7373
public function not(mixed $expected, string $message = ''): self
7474
{

src/Traits/NullAssertions.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ trait NullAssertions
2323
*
2424
* @param string $message Optional custom error message.
2525
*
26-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
26+
* @return self Enables fluent chaining of assertion methods.
2727
*/
2828
public function null(string $message = ''): self
2929
{
@@ -43,7 +43,7 @@ public function null(string $message = ''): self
4343
*
4444
* @param string $message Optional custom error message.
4545
*
46-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
46+
* @return self Enables fluent chaining of assertion methods.
4747
*/
4848
public function notNull(string $message = ''): self
4949
{

src/Traits/NumericAssertions.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ trait NumericAssertions
2727
* @param int|float $expected The value to compare against.
2828
* @param string $message Optional custom error message.
2929
*
30-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
30+
* @return self Enables fluent chaining of assertion methods.
3131
*/
3232
public function isLowerThan(int|float $expected, string $message = ''): self
3333
{
@@ -49,7 +49,7 @@ public function isLowerThan(int|float $expected, string $message = ''): self
4949
* @param int|float $expected The value to compare against.
5050
* @param string $message Optional custom error message.
5151
*
52-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
52+
* @return self Enables fluent chaining of assertion methods.
5353
*/
5454
public function isGreaterThan(int|float $expected, string $message = ''): self
5555
{
@@ -73,7 +73,7 @@ public function isGreaterThan(int|float $expected, string $message = ''): self
7373
*
7474
* @param string $message Optional custom error message.
7575
*
76-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
76+
* @return self Enables fluent chaining of assertion methods.
7777
*/
7878
public function isPositive(string $message = ''): self
7979
{
@@ -93,7 +93,7 @@ public function isPositive(string $message = ''): self
9393
*
9494
* @param string $message Optional custom error message.
9595
*
96-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
96+
* @return self Enables fluent chaining of assertion methods.
9797
*/
9898
public function isNegative(string $message = ''): self
9999
{
@@ -118,7 +118,7 @@ public function isNegative(string $message = ''): self
118118
*
119119
* @param string $message Optional custom error message.
120120
*
121-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
121+
* @return self Enables fluent chaining of assertion methods.
122122
*/
123123
public function isZero(string $message = ''): self
124124
{
@@ -140,7 +140,7 @@ public function isZero(string $message = ''): self
140140
* @param int|float $max The maximum value.
141141
* @param string $message Optional custom error message.
142142
*
143-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
143+
* @return self Enables fluent chaining of assertion methods.
144144
*/
145145
public function isBetween(int|float $min, int|float $max, string $message = ''): self
146146
{

src/Traits/SpecialAssertions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ trait SpecialAssertions
2323
* fact('01ARZ3NDEKTSV4RRFFQ69G5FAV')->ulid(); // Passes (if valid ULID)
2424
* fact('invalid-ulid')->ulid(); // Fails
2525
*
26-
* @return self|fluentAssertions Enables fluent chaining of assertion methods.
26+
* @return self Enables fluent chaining of assertion methods.
2727
*/
2828
public function ulid(): self
2929
{

0 commit comments

Comments
 (0)