Skip to content

Commit 10da067

Browse files
committed
update doc typos
1 parent 87286f1 commit 10da067

15 files changed

+21
-21
lines changed

doc/commands.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ php ./vendor/bin/grumphp run
5151
php ./vendor/bin/grumphp run --testsuite=mytestsuite
5252
```
5353

54-
This command can also be used for continious integration.
54+
This command can also be used for continuous integration.
5555
More information about the testsuites can be found in the [testsuites documentation](testsuites.md).
5656

5757
If you want to run only a subset of the configured tasks, you can run the command with the `--tasks` option:

doc/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ For example:
8585
- Warning: Unsupported declare 'strict_types' in vendor/ocramius/proxy-manager/src/ProxyManager/Configuration.php on line 19
8686
- Parse error: parse error, expecting ';'' or'{'' in vendor/ocramius/proxy-manager/src/ProxyManager/Configuration.php on line 87
8787

88-
SourceTree probably doesn't import your local $PATH variable before running the scripts. This causes a lot of issues like a different PHP version than the one installed locally or exectuables that can't be found.
88+
SourceTree probably doesn't import your local $PATH variable before running the scripts. This causes a lot of issues like a different PHP version than the one installed locally or executables that can't be found.
8989

9090
You can fix this by adding following line to the top of the git hooks:
9191

doc/parameters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Hides the tip describing how to circumvent the Git commit hook and bypass GrumPH
129129

130130
GrumPHP uses the Symfony Process component to run external tasks.
131131
The component will trigger a timeout after 60 seconds by default.
132-
If you've got tools that run more then 60 seconds, you can increase this parameter.
132+
If you've got tools that run more than 60 seconds, you can increase this parameter.
133133
It is also possible to disable the timeout by setting the value to `null`.
134134
When receiving a `Symfony\Component\Process\Exception\ProcessTimedOutException` during the execution of GrumPHP, you probably need to increment this setting.
135135

doc/tasks/eslint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ Report errors only (no warnings). [eslint.org](https://eslint.org/docs/user-guid
111111

112112
**other settings**
113113

114-
Any other eslint settings (such as rules, env, ignore patterns, etc) should be able to be set through an [eslint config file](https://eslint.org/docs/user-guide/configuring) (instructions to generate a config file at top of document).
114+
Any other eslint settings (such as rules, env, ignore patterns, etc.) should be able to be set through an [eslint config file](https://eslint.org/docs/user-guide/configuring) (instructions to generate a config file at top of document).

doc/tasks/gherkin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ grumphp:
1717
*Default: 'features'*
1818
1919
This option will specify the location of your Gherkin feature files.
20-
By default the Behat prefered `features` folder is chosen.
20+
By default the Behat preferred `features` folder is chosen.
2121

2222
**align**
2323

doc/tasks/kahlan.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ To turn off header.
133133
Paths to include for patching.
134134

135135

136-
**exlude**
136+
**exclude**
137137

138138
*Default: `[]`*
139139

doc/tasks/npm_script.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ This option will append 'run' to the npm command to make it possible to run cust
5252
5353
*Default: false*
5454
55-
This option will append '--silent' to the npm script to supress `npm ERR!` messages from showing.
55+
This option will append '--silent' to the npm script to suppress `npm ERR!` messages from showing.

doc/tasks/phan.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This means that `.phan/config.php` is automatically loaded if the file exists in
3636

3737
*Default: text*
3838

39-
This option sets the output mode. Valid outpot modes are 'text', 'json', 'csv', 'codeclimate', 'checkstyle', or 'pylint'.
39+
This option sets the output mode. Valid output modes are 'text', 'json', 'csv', 'codeclimate', 'checkstyle', or 'pylint'.
4040
This option is set to `text` by default.
4141

4242
**output**

doc/tasks/phpcs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ PHP_CodeSniffer will print all screen-based reports 80 characters wide. You may
9797
*Default: []*
9898

9999
This is a list of regex patterns that will filter files to validate. With this option you can skip files like tests. This option is used in relation with the parameter `triggered_by`.
100-
For exemple to validate only files in your `src/App/` and `src/AppBundle/` directories in a Symfony you can use
100+
For example to validate only files in your `src/App/` and `src/AppBundle/` directories in a Symfony you can use
101101
```yml
102102
whitelist_patterns:
103103
- /^src\/App\/(.*)/
@@ -134,7 +134,7 @@ A list of rules that should not be checked. Leave this option blank to run all c
134134

135135
### Symfony 2
136136

137-
If you want to use Phpcs for your Symfony2 projects, you can require the leanpub phpcs repo.
137+
If you want to use Phpcs for your Symfony2 projects, you can require the leaphub phpcs repo.
138138

139139
```sh
140140
composer require --dev leaphub/phpcs-symfony2-standard

doc/tasks/phplint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This option can allow PHP short open tags.
4848
4949
This is a list of patterns that will be ignored by PHPLint. Leave this option blank to run PHPLint for every php file.
5050
51-
**trigered_by**
51+
**triggered_by**
5252
5353
*Default: ['php', 'phtml', 'php3', 'php4', 'php5']*
5454

doc/tasks/phpmnd.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ With this parameter you can define which directory you want to run `phpmnd` in (
4242
*Default: []*
4343

4444
This is a list of regex patterns that will filter files to validate. With this option you can skip files like tests. This option is used in relation with the parameter `triggered_by`.
45-
For exemple to validate only files in your `src/App/` and `src/AppBundle/` directories in a Symfony you can use
45+
For example to validate only files in your `src/App/` and `src/AppBundle/` directories in a Symfony you can use
4646
```yml
4747
whitelist_patterns:
4848
- /^src\/App\/(.*)/

doc/tasks/phpparser.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ grumphp:
7979
declare_strict_types: ~
8080
```
8181

82-
This visitore is not configurable!
82+
This visitor is not configurable!
8383

8484

8585
### forbidden_class_method_calls
@@ -103,7 +103,7 @@ grumphp:
103103

104104
This is a list of blacklisted class method calls. The syntax is `$variableName->methodName`.
105105
When one of the functions inside this list is being called by your code,
106-
the parser will markt this method as an error.
106+
the parser will mark this method as an error.
107107

108108

109109
### forbidden_function_calls
@@ -127,7 +127,7 @@ grumphp:
127127

128128
This is a list of blacklisted function calls.
129129
When one of the functions inside this list is being called by your code,
130-
the parser will markt this method as an error.
130+
the parser will mark this method as an error.
131131

132132
*Note* that statements like `die()` and `exit` are not functions but exit nodes. You can validate these statements by adding the [`no_exit_statements`](https://github.com/phpro/grumphp/blob/master/doc/tasks/phpparser.md#no_exit_statements) visitor to your configuration.
133133

@@ -152,7 +152,7 @@ grumphp:
152152

153153
This is a list of blacklisted static method calls. The syntax is `Fully\Qualified\ClassName::staticMethodName`.
154154
When one of the functions inside this list is being called by your code,
155-
the parser will markt this method as an error.
155+
the parser will mark this method as an error.
156156

157157

158158
### nameresolver
@@ -258,7 +258,7 @@ This will result in easy and understandable visitors!
258258

259259
### Optional interfaces and classes
260260

261-
We also added some optional interfaces and to make it easier to interct with the GrumPHP context:
261+
We also added some optional interfaces and to make it easier to interact with the GrumPHP context:
262262

263263

264264
**ConfigurableVisitorInterface**
@@ -295,7 +295,7 @@ interface ContextAwareVisitorInterface extends NodeVisitor
295295
In the built-in visitors, we use the `AbstractVisitor` that extends the `PhpParser\NodeVisitorAbstract`.
296296
This means that you only have to implement the methods from the `NodeVisitor` that you need.
297297
It also implements the `ContextAwareVisitorInterface` and provides an easy method for logging errors in your custom visitor.
298-
The bleuprint of this abstract visitor looks like this:
298+
The blueprint of this abstract visitor looks like this:
299299

300300

301301
```php

doc/tasks/shell.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ grumphp:
3333
- ["-c", "./bin/command arg1 arg2"]
3434
```
3535

36-
*Note:* When using the `-c` option, the next argument should contain the full executable with all parameters. Be carefull: quotes will be escaped!
36+
*Note:* When using the `-c` option, the next argument should contain the full executable with all parameters. Be careful: quotes will be escaped!
3737

3838

3939
**triggered_by**

doc/tasks/tester.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Always run the whole test suite, even if no PHP files were changed.
4747
4848
*Default: null*
4949
50-
You can wite the testing progress to a file.
50+
You can write the testing progress to a file.
5151
5252
**show_information_about_skipped_tests**
5353

doc/tasks/twigcs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ This option will specify which file extensions will trigger this task.
6060

6161
*Default: []*
6262

63-
This option will specify which relative subfolders or files will be exclude to this task.
63+
This option will specify which relative subfolders or files will be excluded from this task.

0 commit comments

Comments
 (0)