Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typos in docs #179

Merged
merged 1 commit into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ The `Equal` and the `BeIdentical` matchers also check the type, not only the val
The following code will fail in runtime:
```go
x := 5 // x is int
Expect(x).Should(Eqaul(uint(5)) // x and uint(5) are with different
Expect(x).Should(Equal(uint(5)) // x and uint(5) are with different
```
When using negative checks, it's even worse, because we get a false positive:
```
Expand Down Expand Up @@ -234,7 +234,7 @@ flag **is** set.
***Note***: This rule work with best-effort approach. It can't find many cases, like const defined not in the same
package, or when using variables.

The timeout and polling intervals may be passed as optional arguments to the `Eventually` or `Constanly` functions, or
The timeout and polling intervals may be passed as optional arguments to the `Eventually` or `Consistently` functions, or
using the `WithTimeout` or , `Within` methods (timeout), and `WithPolling` or `ProbeEvery` methods (polling).

This rule checks if the async (`Eventually` or `Consistently`) timeout duration, is not shorter than the polling interval.
Expand Down Expand Up @@ -457,7 +457,7 @@ This rule support auto fixing.
***Note***: Only applied when the `suppress-async-assertion` flag is **not set** *and* the `validate-async-intervals`
flag **is** set.

The timeout and polling intervals may be passed as optional arguments to the `Eventually` or `Constanly` functions, or
The timeout and polling intervals may be passed as optional arguments to the `Eventually` or `Consistently` functions, or
using the `WithTimeout` or , `Within` methods (timeout), and `WithPolling` or `ProbeEvery` methods (polling).

The linter checks that there is up to one polling argument and up to one timeout argument.
Expand All @@ -475,7 +475,7 @@ Eventually(aFunc, time.Second*10, time.Millisecond * 500).WithPolling(time.Milli
***Note***: Only applied when the `suppress-async-assertion` flag is **not set** *and* the `validate-async-intervals`
flag **is** set.

gomega supports a few formats for timeout and polling intervals, when using the old format (the last two parameters of Eventually and Constantly):
gomega supports a few formats for timeout and polling intervals, when using the old format (the last two parameters of Eventually and Consistently):
* a `time.Duration` value
* any kind of numeric value (int(8/16/32/64), uint(8/16/32/64) or float(32/64), as the number of seconds.
* duration string like `"12s"`
Expand Down Expand Up @@ -559,7 +559,7 @@ To suppress the wrong async assertion warning, add a comment with (only)

`ginkgo-linter:ignore-async-assert-warning`.

To supress the focus container warning, add a comment with (only)
To suppress the focus container warning, add a comment with (only)

`ginkgo-linter:ignore-focus-container-warning`

Expand All @@ -572,10 +572,10 @@ Notice that this comment will not work for an anonymous variable container like
// ginkgo-linter:ignore-focus-container-warning (not working!!)
var _ = FDescribe(...)
```
In this case, use the file comment (see bellow).
In this case, use the file comment (see below).

There are two options to use these comments:
1. If the comment is at the top of the file, supress the warning for the whole file; e.g.:
1. If the comment is at the top of the file, suppress the warning for the whole file; e.g.:
```go
package mypackage

Expand Down
2 changes: 1 addition & 1 deletion doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ For example:
Eventually(func() bool { return true }, time.Second*10, 500*time.Millisecond).ProbeEvery(time.Millisecond * 500).Should(BeTrue())

* async timing interval: non-time.Duration intervals [Style]
gomega supports a few formats for timeout and polling intervals, when using the old format (the last two parameters of Eventually and Constantly):
gomega supports a few formats for timeout and polling intervals, when using the old format (the last two parameters of Eventually and Consistently):
* time.Duration
* any kind of numeric value, as number of seconds
* duration string like "12s"
Expand Down
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ internal/
+ actual - types to model the actual part of the gomega assertion expression
+ matcher - types to model the matcher part of the gomega assertion expression
+ value - models a value in several actual and matcher types
+ rules - the gomega linter rules. A rule recieves a gomega expression and trigger a linter error if needed.
+ rules - the gomega linter rules. A rule receives a gomega expression and trigger a linter error if needed.
...
...
```
Expand Down
Loading