Skip to content

Commit bce141e

Browse files
committed
Fix remaining RST escape artifacts and grammar issues across docs.
1 parent f72bb67 commit bce141e

File tree

13 files changed

+25
-25
lines changed

13 files changed

+25
-25
lines changed

docs/en/console-commands/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class HelloCommand extends Command
3232
```
3333

3434
Command classes must implement an `execute()` method that does the bulk of
35-
their work. This method is called when a command is invoked. Lets call our first
35+
their work. This method is called when a command is invoked. Let's call our first
3636
command application directory, run:
3737

3838
``` bash

docs/en/console-commands/completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ complete -F _cake cake bin/cake
135135

136136
## Using autocompletion
137137

138-
Once enabled, the autocompletion can be used the same way than for other
138+
Once enabled, the autocompletion can be used the same way as for other
139139
built-in commands, using the **TAB** key.
140140
Three type of autocompletion are provided. The following output are from a fresh CakePHP install.
141141

docs/en/contributing/tickets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ the best bug report possible:
2727

2828
If you've found a security issue in CakePHP, please use the following procedure
2929
instead of the normal bug reporting system. Instead of using the bug tracker,
30-
mailing list or IRC please send an email to **security \[at\] cakephp.org**.
30+
mailing list or IRC please send an email to **security [at] cakephp.org**.
3131
Emails sent to this address go to the CakePHP core team on a private mailing
3232
list.
3333

docs/en/controllers/request-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ If your requests contain XML or JSON request content, you should consider using
296296
types making the parsed data available in `$request->getData()` and
297297
`$request->getParsedBody()`.
298298

299-
### Environment Variables (from \$\_SERVER and \$\_ENV)
299+
### Environment Variables (from $_SERVER and $_ENV)
300300

301301
`method` Cake\\Http\\ServerRequest::**getEnv**($key, $default = null): string|null
302302

docs/en/core-libraries/caching.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ automatically handle key distribution and failover across the cluster nodes.
219219
them as a pool.
220220
- `duration` Be aware that any duration greater than 30 days will be treated as real
221221
Unix time value rather than an offset from current time.
222-
- `options` Additional options for the memcached client. Should be an array of option =\> value.
222+
- `options` Additional options for the memcached client. Should be an array of option => value.
223223
Use the `\Memcached::OPT_*` constants as keys.
224224

225225
<a id="cache-configuration-fallback"></a>
@@ -282,7 +282,7 @@ the config and destroy the adapter if it was constructed.
282282

283283
`static` Cake\\Cache\\Cache::**write**(string $key, mixed $value, string $config = 'default'): bool
284284

285-
`Cache::write()` will write a \$value to the Cache. You can read or
285+
`Cache::write()` will write a `$value` to the Cache. You can read or
286286
delete this value later by referring to it by `$key`. You may
287287
specify an optional configuration to store the cache in as well. If
288288
no `$config` is specified, default will be used. `Cache::write()`

docs/en/core-libraries/logging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Log::warning('This is a warning', 'payments');
231231
As its name implies `FileLog` writes log messages to files. The level of log
232232
message being written determines the name of the file the message is stored in.
233233
If a level is not supplied, `LOG_ERR` is used which writes to the
234-
error log. The default log location is **logs/\$level.log**:
234+
error log. The default log location is **logs/`$level.log`**:
235235

236236
``` php
237237
// Executing this inside a CakePHP class
@@ -452,11 +452,11 @@ configured.
452452

453453
`static` Cake\\Log\\Log::**setConfig**(array|string $key, $config = null): void
454454

455-
param string \$name
455+
param string `$name`
456456
Name for the logger being connected, used
457457
to drop a logger later on.
458458

459-
param array \$config
459+
param array `$config`
460460
Array of configuration information and
461461
constructor arguments for the logger.
462462

@@ -476,7 +476,7 @@ Get the names of the configured loggers.
476476

477477
`static` Cake\\Log\\Log::**drop**(string $name): bool
478478

479-
param string \$name
479+
param string `$name`
480480
Name of the logger you wish to no longer receive
481481
messages.
482482

docs/en/core-libraries/number.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ that represents the amount of money you are expressing. The second
5757
parameter is a string used to choose a predefined currency formatting
5858
scheme:
5959

60-
| \$currency | 1234.56, formatted by currency type |
60+
| `$currency` | 1234.56, formatted by currency type |
6161
|------------|-------------------------------------|
6262
| EUR | €1.234,56 |
6363
| GBP | £1,234.56 |

docs/en/development/debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ the order of currently running functions (stack frames).
153153

154154
`static` Cake\\Error\\Debugger::**excerpt**($file, $line, $context): array
155155

156-
Grab an excerpt from the file at \$path (which is an absolute
157-
filepath), highlights line number \$line with \$context number of
156+
Grab an excerpt from the file at `$path` (which is an absolute
157+
filepath), highlights line number `$line` with `$context` number of
158158
lines around it.
159159

160160
``` php

docs/en/development/errors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ options are supported:
3232
- `extraFatalErrorMemory` - int - Set to the number of megabytes to increase
3333
the memory limit by when a fatal error is encountered. This allows breathing
3434
room to complete logging or error handling.
35-
- `logger` (prior to 4.4.0 use `errorLogger`) -`Cake\Error\ErrorLoggerInterface` - The class responsible for logging
35+
- `logger` (prior to 4.4.0 use `errorLogger`) - `Cake\Error\ErrorLoggerInterface` - The class responsible for logging
3636
errors and unhandled exceptions. Defaults to `Cake\Error\ErrorLogger`.
3737
- `errorRenderer` - `Cake\Error\ErrorRendererInterface` - The class responsible
3838
for rendering errors. Default is chosen based on PHP SAPI.
@@ -515,7 +515,7 @@ In addition, CakePHP uses the following exceptions:
515515
: The requested controller action could not be found.
516516

517517
`Cake\Controller\Exception\PrivateActionException`
518-
: Accessing private/protected/\_ prefixed actions.
518+
: Accessing private/protected/_ prefixed actions.
519519

520520
`Cake\Console\Exception\ConsoleException`
521521
: A console library class encounter an error.

docs/en/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -621,7 +621,7 @@ echo $this->element('Contacts.sidebar/helpbox');
621621
You can override any plugin views from inside your app using special paths. If
622622
you have a plugin called 'ContactManager' you can override the template files of the
623623
plugin with application specific view logic by creating files using the
624-
following template **templates/plugin/\[Plugin\]/\[Controller\]/\[view\].php**. For the
624+
following template **templates/plugin/`[Plugin]/[Controller]/[view]`.php**. For the
625625
Contacts controller you could make the following file:
626626

627627
templates/plugin/ContactManager/Contacts/index.php

0 commit comments

Comments
 (0)