Skip to content

Commit d803307

Browse files
committed
Fix remaining RST conversion artifacts, abbreviations, and double spaces.
- Replace RST escaped underscores \_id with inline code `_id` in associations docs (5 instances) - Replace RST escaped angle brackets \<locale\> with inline code in internationalization docs - Replace RST escaped backticks \` with proper markdown in configuration docs - Replace RST escaped \# with inline code in number docs - Fix "ie." to "i.e." across number.md and events.md (14 instances) - Fix "eg." to "e.g." in saving-data.md - Fix double spaces in html.md and testing.md code comments
1 parent 1a334c7 commit d803307

8 files changed

Lines changed: 24 additions & 24 deletions

File tree

docs/en/core-libraries/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ a more direct approach and only listen to the event you really need:
362362

363363
``` php
364364
// You can create the following before the
365-
// save operation, ie. config/bootstrap.php
365+
// save operation, i.e. config/bootstrap.php
366366
use Cake\Datasource\FactoryLocator;
367367
use Cake\Event\EventInterface;
368368
// If sending emails

docs/en/core-libraries/internationalization-and-localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ separately in a file named **cake.po** in **resources/locales/**.
6262
The [CakePHP localized library](https://github.com/cakephp/localized) houses
6363
translations for the client-facing translated strings in the core (the cake
6464
domain). To use these files, link or copy them into their expected location:
65-
**resources/locales/\<locale\>/cake.po**. If your locale is incomplete or incorrect,
65+
`resources/locales/<locale>/cake.po`. If your locale is incomplete or incorrect,
6666
please submit a PR in this repository to fix it.
6767

6868
Plugins can also contain translation files, the convention is to use the

docs/en/core-libraries/number.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ output. The following options are available:
7070
| ---- | ---- |
7171
| before | Text to display before the rendered number. |
7272
| after | Text to display after the rendered number. |
73-
| zero | The text to use for zero values; can be a string or a number. ie. 0, 'Free!'. |
74-
| places | Number of decimal places to use, ie. 2 |
75-
| precision | Maximal number of decimal places to use, ie. 2 |
76-
| locale | The locale name to use for formatting number, ie. "fr_FR". |
77-
| fractionSymbol | String to use for fraction numbers, ie. ' cents'. |
73+
| zero | The text to use for zero values; can be a string or a number. i.e. 0, 'Free!'. |
74+
| places | Number of decimal places to use, i.e. 2 |
75+
| precision | Maximal number of decimal places to use, i.e. 2 |
76+
| locale | The locale name to use for formatting number, i.e. "fr_FR". |
77+
| fractionSymbol | String to use for fraction numbers, i.e. ' cents'. |
7878
| fractionPosition | Either 'before' or 'after' to place the fraction symbol. |
79-
| pattern | An ICU number pattern to use for formatting the number ie. \#,###.00 |
79+
| pattern | An ICU number pattern to use for formatting the number i.e. `#,###.00` |
8080
| useIntlCode | Set to `true` to replace the currency symbol with the international currency code. |
8181

8282
If `$currency` value is `null`, the default currency will be retrieved from
@@ -216,10 +216,10 @@ resides.
216216

217217
| Option | Description |
218218
| ---- | ---- |
219-
| places | Number of decimal places to use, ie. 2 |
220-
| precision | Maximum number of decimal places to use, ie. 2 |
221-
| pattern | An ICU number pattern to use for formatting the number ie. \#,###.00 |
222-
| locale | The locale name to use for formatting number, ie. "fr_FR". |
219+
| places | Number of decimal places to use, i.e. 2 |
220+
| precision | Maximum number of decimal places to use, i.e. 2 |
221+
| pattern | An ICU number pattern to use for formatting the number i.e. `#,###.00` |
222+
| locale | The locale name to use for formatting number, i.e. "fr_FR". |
223223
| before | Text to display before the rendered number. |
224224
| after | Text to display after the rendered number. |
225225

@@ -302,9 +302,9 @@ The `$options` parameter takes the same keys as `Number::format()` itself:
302302

303303
| Option | Description |
304304
|-----------|------------------------------------------------------------|
305-
| places | Number of decimal places to use, ie. 2 |
306-
| precision | Maximum number of decimal places to use, ie. 2 |
307-
| locale | The locale name to use for formatting number, ie. "fr_FR". |
305+
| places | Number of decimal places to use, i.e. 2 |
306+
| precision | Maximum number of decimal places to use, i.e. 2 |
307+
| locale | The locale name to use for formatting number, i.e. "fr_FR". |
308308
| before | Text to display before the rendered number. |
309309
| after | Text to display after the rendered number. |
310310

docs/en/development/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ a PHP configuration file loadable by the
512512
`Cake\Core\Configure\Engine\PhpConfig`
513513
514514
Given that the 'default' engine is an instance of PhpConfig.
515-
Save all data in Configure to the file \`my_config.php\`:
515+
Save all data in Configure to the file `my_config.php`:
516516
517517
``` php
518518
Configure::dump('my_config', 'default');

docs/en/development/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1281,7 +1281,7 @@ $this->assertSession('That article does not exist', 'Flash.flash.0.message');
12811281
// Assert a flash message in the 'flash' key.
12821282
$this->assertFlashMessage('Article deleted', 'flash');
12831283

1284-
// Assert the second flash message, also in the 'flash' key.
1284+
// Assert the second flash message, also in the 'flash' key.
12851285
$this->assertFlashMessageAt(1, 'Article really deleted');
12861286

12871287
// Assert a flash message in the 'auth' key at the first position

docs/en/orm/associations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Possible keys for hasOne association arrays include:
222222
it should be 'Addresses'. The default value is the name of the association.
223223
- **foreignKey**: The name of the foreign key column in the other table. The
224224
default value is the underscored, singular name of the current model,
225-
suffixed with '\_id' such as 'user_id' in the above example.
225+
suffixed with `_id` such as 'user_id' in the above example.
226226
- **bindingKey**: The name of the column in the current table used to match the
227227
`foreignKey`. The default value is the primary key of the current table
228228
such as 'id' of Users in the above example.
@@ -319,7 +319,7 @@ Possible keys for belongsTo association arrays include:
319319
it should be 'Users'. The default value is the name of the association.
320320
- **foreignKey**: The name of the foreign key column in the current table. The
321321
default value is the underscored, singular name of the other model,
322-
suffixed with '\_id' such as 'user_id' in the above example.
322+
suffixed with `_id` such as 'user_id' in the above example.
323323
- **bindingKey**: The name of the column in the other table used to match the
324324
`foreignKey`. The default value is the primary key of the other table
325325
such as 'id' of Users in the above example.
@@ -438,7 +438,7 @@ Possible keys for hasMany association arrays include:
438438
it should be 'Comments'. The default value is the name of the association.
439439
- **foreignKey**: The name of the foreign key column in the other table. The
440440
default value is the underscored, singular name of the current model,
441-
suffixed with '\_id' such as 'article_id' in the above example.
441+
suffixed with `_id` such as 'article_id' in the above example.
442442
- **bindingKey**: The name of the column in the current table used to match the
443443
`foreignKey`. The default value is the primary key of the current table
444444
such as 'id' of Articles in the above example.
@@ -585,13 +585,13 @@ Possible keys for belongsToMany association arrays include:
585585
found on the join table, or list in case of composite foreign keys.
586586
This is especially handy if you need to define multiple
587587
belongsToMany relationships. The default value for this key is the
588-
underscored, singular name of the current model, suffixed with '\_id'.
588+
underscored, singular name of the current model, suffixed with `_id`.
589589
- **bindingKey**: The name of the column in the current table, that will be used
590590
for matching the `foreignKey`. Defaults to the primary key.
591591
- **targetForeignKey**: The name of the foreign key that references the target
592592
model found on the join model, or list in case of composite foreign keys.
593593
The default value for this key is the underscored, singular name of
594-
the target model, suffixed with '\_id'.
594+
the target model, suffixed with `_id`.
595595
- **conditions**: An array of `find()` compatible conditions. If you have
596596
conditions on an associated table, you should use a 'through' model, and
597597
define the necessary belongsTo associations on it. It is recommended to

docs/en/orm/saving-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1091,7 +1091,7 @@ $article->setDirty('tags', true);
10911091
Without the call to `setDirty()` the updated tags will not be saved.
10921092

10931093
Often you'll find yourself wanting to make an association between two existing
1094-
entities, eg. a user coauthoring an article. This is done by using the method
1094+
entities, e.g. a user coauthoring an article. This is done by using the method
10951095
`link()`, like this:
10961096

10971097
``` php

docs/en/views/helpers/html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ echo $this->Html->meta(
160160
['type' => 'icon'],
161161
);
162162
// Output (line breaks added)
163-
// Note: The helper code makes two meta tags to ensure the
163+
// Note: The helper code makes two meta tags to ensure the
164164
// icon is downloaded by both newer and older browsers
165165
// which require different rel attribute values.
166166
<link

0 commit comments

Comments
 (0)