Skip to content

Commit

Permalink
Doc changes (#187)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
phil-davis authored Apr 19, 2020
1 parent ab2cb0b commit 589f484
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tests/AssertTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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');

Expand Down

0 comments on commit 589f484

Please sign in to comment.