From 589f484df0772d21076e8cd57d441e7a72ce5b88 Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Sun, 19 Apr 2020 13:43:34 +0545 Subject: [PATCH] Doc changes (#187) * Minor grammar corrections to method descriptions * Correction to typo in 1.8.0 changelog * Minor grammar corrections in changelog * Fix typo in test method name --- CHANGELOG.md | 6 +++--- README.md | 6 +++--- tests/AssertTest.php | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6326a2d6..276ff44b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,7 @@ Changelog ### Fixed -* Exception messages of comparisons between `DateTime(Immutalbe)` objects now display their date & time. +* Exception messages of comparisons between `DateTime(Immutable)` objects now display their date & time. * Custom Exception messages for `Assert::count()` now use the values to render the exception message. ## 1.7.0 (2020-02-14) @@ -43,7 +43,7 @@ Changelog They are countable, without implementing the `Countable` interface. * The doc block of `range` now has the proper variables. * An empty array will now pass `isList` and `isMap`. As it is a valid form of both. -If a non empty variant is needed, use `isNonEmptyList` or `isNonEmptyMap`. +If a non-empty variant is needed, use `isNonEmptyList` or `isNonEmptyMap`. ### Changed @@ -66,7 +66,7 @@ If you don't use psalm, then this has no impact. ### Fixed -* `Assert::endsWith()` would not give the correct result when dealing with multibyte suffix. +* `Assert::endsWith()` would not give the correct result when dealing with a multibyte suffix. * `Assert::length(), minLength, maxLength, lengthBetween` would not give the correct result when dealing with multibyte characters. **NOTE**: These 2 changes may break your assertions if you relied on the fact that multibyte characters didn't behave correctly. diff --git a/README.md b/README.md index e316d538..1407a9a1 100644 --- a/README.md +++ b/README.md @@ -104,10 +104,10 @@ Method | Description `isIterable($value, $message = '')` | Check that a value is an array or a `\Traversable` `isCountable($value, $message = '')` | Check that a value is an array or a `\Countable` `isInstanceOf($value, $class, $message = '')` | Check that a value is an `instanceof` a class -`isInstanceOfAny($value, array $classes, $message = '')` | Check that a value is an `instanceof` a at least one class on the array of classes +`isInstanceOfAny($value, array $classes, $message = '')` | Check that a value is an `instanceof` at least one class on the array of classes `notInstanceOf($value, $class, $message = '')` | Check that a value is not an `instanceof` a class `isAOf($value, $class, $message = '')` | Check that a value is of the class or has one of its parents -`isAnyOf($value, array $classes, $message = '')` | Check that a value a at least one of the class or has one of its parents +`isAnyOf($value, array $classes, $message = '')` | Check that a value is of at least one of the classes or has one of its parents `isNotA($value, $class, $message = '')` | Check that a value is not of the class or has not one of its parents `isArrayAccessible($value, $message = '')` | Check that a value can be accessed as an array `uniqueValues($values, $message = '')` | Check that the given array contains unique values @@ -143,7 +143,7 @@ any of the following assertions. Method | Description --------------------------------------------------- | ----------------------------------------------------------------- `contains($value, $subString, $message = '')` | Check that a string contains a substring -`notContains($value, $subString, $message = '')` | Check that a string does not contains a substring +`notContains($value, $subString, $message = '')` | Check that a string does not contain a substring `startsWith($value, $prefix, $message = '')` | Check that a string has a prefix `notStartsWith($value, $prefix, $message = '')` | Check that a string does not have a prefix `startsWithLetter($value, $message = '')` | Check that a string starts with a letter diff --git a/tests/AssertTest.php b/tests/AssertTest.php index a5ade77c..c1f708b9 100644 --- a/tests/AssertTest.php +++ b/tests/AssertTest.php @@ -718,7 +718,7 @@ public function testConvertValuesToStrings($method, $args, $exceptionMessage) call_user_func_array(array('Webmozart\Assert\Assert', $method), $args); } - public function testAnUnkownMethodThrowsABadMethodCall() + public function testAnUnknownMethodThrowsABadMethodCall() { $this->setExpectedException('\BadMethodCallException');