Skip to content

Commit da226d0

Browse files
luizcmarinvjik
andauthored
Fix docs (#110)
Co-authored-by: Sergei Predvoditelev <[email protected]>
1 parent d0507ce commit da226d0

File tree

8 files changed

+306
-302
lines changed

8 files changed

+306
-302
lines changed

LICENSE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without
55
modification, are permitted provided that the following conditions
66
are met:
77

8-
* Redistributions of source code must retain the above copyright
8+
* Redistributions of source code must retain the above copyright
99
notice, this list of conditions and the following disclaimer.
10-
* Redistributions in binary form must reproduce the above copyright
10+
* Redistributions in binary form must reproduce the above copyright
1111
notice, this list of conditions and the following disclaimer in
1212
the documentation and/or other materials provided with the
1313
distribution.
14-
* Neither the name of Yii Software nor the names of its
14+
* Neither the name of Yii Software nor the names of its
1515
contributors may be used to endorse or promote products derived
1616
from this software without specific prior written permission.
1717

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<a href="https://github.com/yiisoft" target="_blank">
3-
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
3+
<img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
44
</a>
55
<h1 align="center">Yii Error Handler</h1>
66
<br>
@@ -37,7 +37,7 @@ The package provides advanced error handling. The features are:
3737

3838
## Installation
3939

40-
The package could be installed with composer:
40+
The package could be installed with [Composer](https://getcomposer.org):
4141

4242
```shell
4343
composer require yiisoft/error-handler
@@ -229,18 +229,22 @@ For example:
229229

230230
## Documentation
231231

232-
- [Yii guide to handling errors (English)](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/handling-errors.md)
233-
- [Guia Yii para lidar com erros (Português - Brasil)](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/handling-errors.md)
232+
- [Yii guide to handling errors](https://github.com/yiisoft/docs/blob/master/guide/en/runtime/handling-errors.md)
234233
- [Internals](docs/internals.md)
235234

236-
## Credits
235+
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
236+
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
237237

238-
The Yii Error Handler use code of [Highlight.js](https://highlightjs.org/) by Ivan Sagalaev and other contributors.
238+
## License
239239

240-
## Support
240+
The Yii Error Handler is free software. It is released under the terms of the BSD License.
241+
Please see [`LICENSE`](./LICENSE.md) for more information.
241242

242-
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
243-
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
243+
Maintained by [Yii Software](https://www.yiiframework.com/).
244+
245+
## Credits
246+
247+
The Yii Error Handler use code of [Highlight.js](https://highlightjs.org/) by Ivan Sagalaev and other contributors.
244248

245249
## Support the project
246250

@@ -253,10 +257,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
253257
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
254258
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
255259
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
256-
257-
## License
258-
259-
The Yii Error Handler is free software. It is released under the terms of the BSD License.
260-
Please see [`LICENSE`](./LICENSE.md) for more information.
261-
262-
Maintained by [Yii Software](https://www.yiiframework.com/).

UPGRADE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Upgrading Instructions
1+
# Yii Error Handler Upgrading Instructions
22

33
## Changes summary

composer.json

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,22 @@
1414
"license": "BSD-3-Clause",
1515
"support": {
1616
"issues": "https://github.com/yiisoft/error-handler/issues?state=open",
17+
"source": "https://github.com/yiisoft/error-handler",
1718
"forum": "https://www.yiiframework.com/forum/",
1819
"wiki": "https://www.yiiframework.com/wiki/",
1920
"irc": "ircs://irc.libera.chat:6697/yii",
20-
"chat": "https://t.me/yii3en",
21-
"source": "https://github.com/yiisoft/error-handler"
21+
"chat": "https://t.me/yii3en"
2222
},
23+
"funding": [
24+
{
25+
"type": "opencollective",
26+
"url": "https://opencollective.com/yiisoft"
27+
},
28+
{
29+
"type": "github",
30+
"url": "https://github.com/sponsors/yiisoft"
31+
}
32+
],
2333
"require": {
2434
"php": "^8.0",
2535
"ext-dom": "*",

docs/internals.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
2525
./vendor/bin/psalm
2626
```
2727

28-
## Rector
28+
## Code style
2929

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

37-
## Composer require checker
37+
## Dependencies
3838

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

4342
```shell
4443
./vendor/bin/composer-require-checker

templates/_call-stack-item.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
</svg>
1919
HTML;
2020
?>
21-
<li class="<?= (!empty($lines) && ($index === 1 || !$isVendorFile)) ? 'application ' : '' ?>call-stack-item" data-line="<?= (int) ($line - $begin) ?>">
21+
<li class="<?= (!empty($lines) && ($index === 1 || !$isVendorFile)) ? 'application ' : '' ?>call-stack-item"
22+
data-line="<?= (int) ($line - $begin) ?>">
2223
<div class="element-wrap">
2324
<div class="flex-1">
2425
<?php if ($file !== null): ?>
@@ -60,4 +61,4 @@
6061
</div>
6162
</div>
6263
<?php endif ?>
63-
</li>
64+
</li>

0 commit comments

Comments
 (0)