Fix docs (#67)

yiisoft · May 2, 2024 · 449d2b0 · 449d2b0
1 parent 9c85406
commit 449d2b0
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 40 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -6,14 +6,14 @@ modification, are permitted provided that the following conditions
 are met:
 
 * Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
+  notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in
-   the documentation and/or other materials provided with the
-   distribution.
+  notice, this list of conditions and the following disclaimer in
+  the documentation and/or other materials provided with the
+  distribution.
 * Neither the name of Yii Software nor the names of its
-   contributors may be used to endorse or promote products derived
-   from this software without specific prior written permission.
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

diff --git a/README.md b/README.md
@@ -34,23 +34,6 @@ The package could be installed with composer:
 composer require yiisoft/cache-memcached
 ```
 
-## Development environment
-
-For greater ease it is recommended to use docker containers.
-
-Run container with memcached directly via command:
-
-```dockerfile
-docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23
-```
-
-Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
-of memcached container. Use `docker run` command argument for it:
-
-```shell
---network container:yiisoft-cache-memcached-cache
-```
-
 ## Configuration
 
 Creating an instance:
@@ -145,10 +128,15 @@ This package can be used as a cache handler for the [Yii Caching Library](https:
 
 - [Internals](docs/internals.md)
 
-## Support
+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. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
+
+## License
+
+The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
 
-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.
-You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
+Maintained by [Yii Software](https://www.yiiframework.com/).
 
 ## Support the project
 
@@ -161,10 +149,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
 [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
-
-## License
-
-The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License.
-Please see [`LICENSE`](./LICENSE.md) for more information.
-
-Maintained by [Yii Software](https://www.yiiframework.com/).
diff --git a/docs/internals.md b/docs/internals.md
@@ -1,5 +1,22 @@
 # Internals
 
+## Development environment
+
+For greater ease it is recommended to use docker containers.
+
+Run container with memcached directly via command:
+
+```shell
+docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23
+```
+
+Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network
+of memcached container. Use `docker run` command argument for it:
+
+```shell
+--network container:yiisoft-cache-memcached-cache
+```
+
 ## Unit testing
 
 The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
@@ -25,7 +42,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:
@@ -34,11 +51,10 @@ use either newest or any specific version of PHP:
 ./vendor/bin/rector
 ```
 
-## Composer require checker
-
-This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
+## Dependencies
 
-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

diff --git a/src/Memcached.php b/src/Memcached.php
@@ -250,8 +250,7 @@ private function normalizeServers(array $servers): array
                 || (isset($server['weight']) && !is_int($server['weight']))
             ) {
                 throw new InvalidArgumentException(
-                    'Each entry in servers parameter is supposed to be an array'
-                        . ' containing hostname (string), port (int), and, optionally, weight (int) of the server.',
+                    'Each entry in servers parameter is supposed to be an array containing hostname (string), port (int), and, optionally, weight (int) of the server.',
                 );
             }
             /**