Skip to content

Commit

Permalink
Fix docs (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
vjik authored May 15, 2024
1 parent e27137c commit 368324a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The package provides an ability to record performance profiles.
The package could be installed with [Composer](https://getcomposer.org):

```shell
composer require yiisoft/profiler
composer require --dev yiisoft/profiler
```

If you use this package with [Yii Config](https://github.com/yiisoft/config) and there will be no `@runtime` alias in `yiisoft/aliases` configuration defined, application will throw "Invalid path alias" error.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@
"test": "phpunit --testdox --no-interaction",
"test-watch": "phpunit-watcher watch"
}
}
}
9 changes: 4 additions & 5 deletions docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```

## Rector
## Code style

Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
use either newest or any specific version of PHP:
Expand All @@ -34,11 +34,10 @@ use either newest or any specific version of PHP:
./vendor/bin/rector
```

## Composer require checker
## Dependencies

This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.

To run the checker, execute the following command:
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if
all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
Expand Down

0 comments on commit 368324a

Please sign in to comment.