README: add precision on custom matchers [ci skip] #125
Conversation
README.md
Outdated
|
|
||
| #### B) Custom matchers | ||
|
|
||
| If Cuckoo doesn't know to type your try to compare, you have to write your own method `equal(to:)` using a `ParameterMatcher`. Add this this method to your test file: |
There was a problem hiding this comment.
I think this should be "If Cuckoo doesn't know the type you are trying to compare, ..."
Also, there is duplicate "this" in the next sentence.
README.md
Outdated
|
|
||
| For details and implementation example (with Alamofire), see [this issue](https://github.com/Brightify/Cuckoo/issues/124). | ||
|
|
||
| #### Parameter matchers | ||
|
|
||
| `ParameterMatcher` also conform to `Matchable`. You can create your own `ParameterMatcher` instances or if you want to directly use your custom types there is the `Matchable` protocol. Standard instances of `ParameterMatcher` can be obtain via these functions: |
There was a problem hiding this comment.
"also conforms to ..."
In the last sentence: "can be obtained ..."
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| ⚠️ If you try to match an object with an unknown or non-`Matchable` type, this could lead to a: |
There was a problem hiding this comment.
This may be subjective, but I feel that "this could lead to a:" would feel more natural as "it can lead to:". Removing the "a" as well, I would suggest keep it if it was one sentence, but when you're using a colon, it seems pointless.
My reasoning is that "this" in this sense is mainly used at the beginning of sentences, but here it's not a new sentence.
Consider these two shorter examples,
"If you fall down, it can lead to a hospital visit."
and
"If you fall down, this can lead to a hospital visit."
There was a problem hiding this comment.
Very clear and instructive: thanks a lot for those explanations! 👍 It makes totally sense, and I've updated the doc accordingly.
|
Thx a lot @sparkesix for this review! I'll make the suggested changes. 👍 |
|
Merged. Thanks for the PR! |
Following #124, a few more explanations on custom matchers.