Skip to content

Commit

Permalink
Changed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianmiu committed Oct 10, 2023
1 parent 86584d1 commit 9e4fcd7
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 91 deletions.
36 changes: 18 additions & 18 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org

root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_size = 2
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org

root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_size = 2
16 changes: 8 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/docs export-ignore
/tests export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.scrutinizer.yml export-ignore
/.travis.yml export-ignore
/couscous.yml export-ignore
/index.md export-ignore
/docs export-ignore
/tests export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.scrutinizer.yml export-ignore
/.travis.yml export-ignore
/couscous.yml export-ignore
/index.md export-ignore
30 changes: 16 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
build/
.settings/
.buildpath
.project
vendor
composer.lock
.idea/
website/
docs/.couscous
docs/couscous.phar
php-cs-fixer.phar
phpcbf.phar
phpcs.phar
phpmd.phar
build/
.settings/
.buildpath
.project
vendor
composer.lock
.idea/
website/
docs/.couscous
docs/couscous.phar
php-cs-fixer.phar
phpcbf.phar
phpcs.phar
phpmd.phar
/.php-cs-fixer.cache
/tests/.phpunit.result.cache
42 changes: 21 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License

Copyright (c) 2023 SiriusPHP

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License
Copyright (c) 2023 SiriusPHP
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 3 additions & 2 deletions docs/3_callable_modifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $processor->get('stack')
$processor->process('stack', $param_1, $param_2, $param_3, $param_4);
```

This modifier is used by the "actions processor" and the "filters processor"
This modifier is used by the [actions processor](2_4_wordpress_actions.md) and the [filters processor](2_5_wordpress_filters.md)

## The "once" modifier

Expand Down Expand Up @@ -77,8 +77,9 @@ This modifier can be used when you have a callable that has a specific signature
```php
use function Sirius\StackRunner\with_arguments;
use function Sirius\StackRunner\ref;
use function Sirius\StackRunner\arg;
$processor->get('stack')
->add(with_arguments('Service@method', [ref(0), 'value', ref('SomeClass'), ref(1)]);
->add(with_arguments('Service@method', [arg(0), 'value', ref('SomeClass'), arg(1)]);

$processor->process('stack', $param_1, $param_2);

Expand Down
28 changes: 0 additions & 28 deletions phpmd.xml

This file was deleted.

0 comments on commit 9e4fcd7

Please sign in to comment.