From 73011ad08113839904de9fa02e405ee5396a091a Mon Sep 17 00:00:00 2001 From: Oleksandr Redko Date: Mon, 2 Dec 2024 18:01:49 +0200 Subject: [PATCH] fix typo in README --- README.md | 12 ++++++------ docs/CONTRIBUTING.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dff0194..182c712 100644 --- a/README.md +++ b/README.md @@ -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: ``` @@ -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 `Constantly` 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. @@ -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 `Constantly` 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. @@ -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` @@ -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 diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8a0948e..2b0ea3f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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. ... ... ```