Skip to content

Commit 9084748

Browse files
Kharhamelmoufmouf
andauthored
Apply suggestions from code review
Co-Authored-By: David Négrier <[email protected]>
1 parent 35c9cc2 commit 9084748

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ $ php ./safe.php generate
3838

3939
## Special cases
4040

41-
In some cases, automatic generation is to difficult to execute and the function has to be written manually.
41+
In some cases, automatic generation is too difficult to execute and the function has to be written manually.
4242
This should however only be done exceptionally in order to keep the project easy to maintain.
43-
The most important example are all the functions of the classes DateTime and DateTimeImmutable, since the entire classes have to be overloaded.
43+
The most important examples are all the functions of the classes `DateTime` and `DateTimeImmutable`, since the entire classes have to be overloaded manually.
4444
All custom objects must be located in lib/ and custom functions must be in lib/special_cases.php.
4545

4646
### Submitting a PR

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ $content = file_get_contents('foobar.json');
5959
$foobar = json_decode($content);
6060
```
6161

62-
All PHP functions that can return 'false' on error are part of Safe.
63-
In addition, Safe also provide 2 'Safe' classes: Safe\DateTime and Safe\DateTimeImmutable whose methods will throw exceptions instead of returning false.
62+
All PHP functions that can return `false` on error are part of Safe.
63+
In addition, Safe also provide 2 'Safe' classes: `Safe\DateTime` and `Safe\DateTimeImmutable` whose methods will throw exceptions instead of returning false.
6464

6565
## PHPStan integration
6666

lib/DateTime.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
use DateTimeZone;
88
use Safe\Exceptions\DatetimeException;
99

10-
//this class is used to implement a safe version of the Datetime
10+
/** this class implements a safe version of the Datetime class */
1111
class DateTime extends \DateTime
1212
{
1313
//switch from regular datetime to safe version

0 commit comments

Comments
 (0)