Browse Source

Improve wording, grammar, punctuation etc.

ravage84 5 years ago
parent
commit
cfe283cfeb

+ 3 - 3
.github/CONTRIBUTING.md

@@ -64,7 +64,7 @@ To run the test cases locally use the following command:
     vendor/bin/phpunit
 
 You can copy file `phpunit.xml.dist` to `phpunit.xml` and modify the database
-driver settings as required to run tests for particular database.
+driver settings as required to run tests for a particular database.
 
 You can also register on [Travis CI](https://travis-ci.org/) and from your
 [profile](https://travis-ci.org/profile) page enable the service hook for your
@@ -75,12 +75,12 @@ To run the sniffs for CakePHP coding standards:
     vendor/bin/phpcs -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src
 
 Check the [cakephp-codesniffer](https://github.com/cakephp/cakephp-codesniffer)
-repository to setup the CakePHP standard. The [README](https://github.com/cakephp/cakephp-codesniffer/blob/master/README.md) contains installation info
+repository to set up the CakePHP standard. The [README](https://github.com/cakephp/cakephp-codesniffer/blob/master/README.md) contains installation info
 for the sniff and phpcs.
 
 ## Reporting a Security Issue
 
-If you've found a security related issue in CakePHP, please don't open an issue in github. Instead contact us at security@cakephp.org. For more information on how we handle security issues, [see the CakePHP Security Issue Process](https://book.cakephp.org/4/en/contributing/tickets.html#reporting-security-issues).
+If you've found a security related issue in CakePHP, please don't open an issue in github. Instead, contact us at security@cakephp.org. For more information on how we handle security issues, [see the CakePHP Security Issue Process](https://book.cakephp.org/4/en/contributing/tickets.html#reporting-security-issues).
 
 # Additional Resources
 

+ 1 - 1
src/Cache/README.md

@@ -39,7 +39,7 @@ $object = new FileEngine($config);
 Cache::config('other', $object);
 ```
 
-You can now read a write from the cache:
+You can now read and write from the cache:
 
 ```php
 $data = Cache::remember('my_cache_key', function () {

+ 1 - 1
src/Console/README.md

@@ -9,7 +9,7 @@ parsers, and dispatching commands.
 
 # Getting Started
 
-To start, define an an entry point script and Application class that defines
+To start, define an entry point script and Application class which defines
 bootstrap logic, and binds your commands. Lets put our entrypoint script in
 `bin/tool.php`:
 

+ 1 - 1
src/Core/README.md

@@ -26,7 +26,7 @@ Configure::load('app', 'default', false);
 Configure::load('other_config', 'default');
 ```
 
-And Write the configuration back into files:
+And write the configuration back into files:
 
 ```php
 Configure::dump('my_config', 'default');

+ 1 - 1
src/Datasource/README.md

@@ -27,7 +27,7 @@ Additionally, this package provides a few traits and classes you can use in your
 
 * `EntityTrait` - Contains the default implementation for the `EntityInterface`.
 * `QueryTrait` - Exposes the methods for creating a query object capable of returning decoratable collections.
-* `ResultSetDecorator` - Decorates any traversable object so it complies with `ResultSetInterface`.
+* `ResultSetDecorator` - Decorates any traversable object, so it complies with `ResultSetInterface`.
 
 
 ## Connections

+ 1 - 1
src/Filesystem/README.md

@@ -1,7 +1,7 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/cakephp/filesystem.svg?style=flat-square)](https://packagist.org/packages/cakephp/filesystem)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.txt)
 
-# This package is deprecated.
+# This package has been deprecated.
 
 ## CakePHP Filesystem Library
 

+ 2 - 2
src/Http/README.md

@@ -9,7 +9,7 @@ handle incoming server requests and send outgoing HTTP requests.
 
 ## Using the Http Client
 
-Sending requests is straight forward. Doing a GET request looks like
+Sending requests is straight forward. Doing a GET request looks like:
 
 ```php
 use Cake\Http\Client;
@@ -34,7 +34,7 @@ To learn more read the [Http Client documentation](https://book.cakephp.org/4/en
 
 The Http Server allows an `HttpApplicationInterface` to process requests and
 emit responses. To get started first implement the
-`Cake\Http\HttpApplicationInterface`  A minimal example would could look like:
+`Cake\Http\HttpApplicationInterface`  A minimal example could look like:
 
 ```php
 namespace App;

+ 1 - 1
src/Log/README.md

@@ -8,7 +8,7 @@ multiple logging backends using a simple interface. With the `Log` class it is
 possible to send a single message to multiple logging backends at the same time
 or just a subset of them based on the log level or context.
 
-By default you can use Files or Syslog as logging backends, but you can use any
+By default, you can use Files or Syslog as logging backends, but you can use any
 object implementing `Psr\Log\LoggerInterface` as an engine for the `Log` class.
 
 ## Usage

+ 5 - 5
src/ORM/README.md

@@ -59,7 +59,7 @@ use Cake\ORM\Locator\LocatorAwareTrait;
 $articles = $this->getTableLocator()->get('Articles');
 ```
 
-By default classes using `LocatorAwareTrait` will share a global locator instance.
+By default, classes using `LocatorAwareTrait` will share a global locator instance.
 You can inject your own locator instance into the object:
 
 ```php
@@ -78,8 +78,8 @@ In your table classes you can define the relations between your tables. CakePHP'
 supports 4 association types out of the box:
 
 * belongsTo - E.g. Many articles belong to a user.
-* hasOne - E.g. A user has one profile
-* hasMany - E.g. A user has many articles
+* hasOne - E.g. A user has one profile.
+* hasMany - E.g. A user has many articles.
 * belongsToMany - E.g. An article belongsToMany tags.
 
 You define associations in your table's `initialize()` method. See the
@@ -149,7 +149,7 @@ $articles->delete($article);
 
 ## Meta Data Cache
 
-It is recommended to enable meta data cache for production systems to avoid performance issues.
+It is recommended to enable metadata cache for production systems to avoid performance issues.
 For e.g. file system strategy your bootstrap file could look like this:
 
 ```php
@@ -164,7 +164,7 @@ $cacheConfig = [
 Cache::setConfig('_cake_model_', $cacheConfig);
 ```
 
-Cache configs are optional so you must require ``cachephp/cache`` to add one.
+Cache configs are optional, so you must require ``cachephp/cache`` to add one.
 
 ## Creating Custom Table and Entity Classes