Skip to content

Commit 29d6a7d

Browse files
committed
tiny fixes in Readme
1 parent a64f802 commit 29d6a7d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ This will probably happen when using the old format:
249249
Eventually(aFunc, 500 * time.Millisecond /*timeout*/, 10 * time.Second /*polling*/).Should(Succeed())
250250
```
251251

252-
### Correct usage of the `Succeed()` matcher [Bug]
252+
### Prevent Wrong Actual Values with the Succeed() matcher [Bug]
253253
The `Succeed()` matcher only accepts a single error value. this rule validates that.
254254

255255
For example:
@@ -271,6 +271,8 @@ a Gomega object as their first parameter, and returns nothing, e.g. this is a va
271271
}).WithTimeout(10 * time.Millisecond).WithPolling(time.Millisecond).Should(Succeed())
272272
```
273273

274+
***Note***: This rule **does not** support auto-fix.
275+
274276
### Avoid Spec Pollution: Don't Initialize Variables in Container Nodes [BUG/STYLE]:
275277
***Note***: Only applied when the `--forbid-spec-pollution=true` flag is set (disabled by default).
276278

@@ -522,6 +524,8 @@ will trigger a warning with a suggestion to replace the mather to
522524
```
523525
***This rule is disabled by default***. Use the `--force-succeed=true` command line flag to enable it.
524526

527+
***Note***: This rule **does** support auto-fix, when the `--fix` command line parameter is used.
528+
525529
## Suppress the linter
526530
### Suppress warning from command line
527531
* Use the `--suppress-len-assertion=true` flag to suppress the wrong length and cap assertions warning

0 commit comments

Comments
 (0)