Skip to content

Commit f72bb67

Browse files
authored
Fix remaining docs issues: grammar, typos, broken content, and RST artifacts. (#8205)
1 parent 211155a commit f72bb67

File tree

16 files changed

+26
-30
lines changed

16 files changed

+26
-30
lines changed

docs/en/appendices/5-2-migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ bin/cake upgrade rector --rules cakephp52 <path/to/app/src>
4545
### Event
4646

4747
- Returning values from event listeners / callbacks is deprecated. Use `$event->setResult()`
48-
instead or `$event->stopPropogation()` to just stop the event propogation.
48+
instead or `$event->stopPropagation()` to just stop the event propagation.
4949

5050
### View
5151

docs/en/appendices/5-3-migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you are not running on **PHP 8.2 or higher**, you will need to upgrade PHP be
4141

4242
### Validation
4343

44-
- The signature of `Validator::validate(array $data, bool $newRecord = true, array $context = [])` has now a additional third parameter `$context`.
44+
- The signature of `Validator::validate(array $data, bool $newRecord = true, array $context = [])` now has an additional third parameter `$context`.
4545
It can be used to pass necessary context into the validation when marshalling.
4646

4747
### View

docs/en/console-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ command. Then learn more about commands:
141141
## Routing in the Console Environment
142142

143143
In command-line interface (CLI), specifically your console commands,
144-
`env('HTTP_HOST')` and other webbrowser specific environment variables are not
144+
`env('HTTP_HOST')` and other web browser specific environment variables are not
145145
set.
146146

147147
If you generate reports or send emails that make use of `Router::url()` those

docs/en/contributing/code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ branch, as you cannot edit it once the pull request is created.
126126
should choose the branch with the next version number. For example if the
127127
current stable release is `4.0.0`, the branch accepting new features will
128128
be `4.next`.
129-
- If your change is a breaks existing functionality, or APIs then you'll have
130-
to choose then next major release. For example, if the current release is
129+
- If your change breaks existing functionality, or APIs then you'll have
130+
to choose the next major release. For example, if the current release is
131131
`4.0.0` then the next time existing behavior can be broken will be in
132132
`5.x` so you should target that branch.
133133

docs/en/contributing/documentation.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ npx markdownlint-cli --config .github/markdownlint.json "docs/en/**/*.md"
512512

513513
```bash [Auto-fix]
514514
# Automatically fix formatting issues
515-
npx markdownlint-cli --config .github/markdownlint.json --fix cs/en/**/*.md"
515+
npx markdownlint-cli --config .github/markdownlint.json --fix "docs/en/**/*.md"
516516
```
517517

518518
:::
@@ -599,11 +599,7 @@ npx cspell --config .github/cspell.json docs/en/your-file.md
599599
node bin/check-links.js docs/en/your-file.md
600600
```
601601

602-
:::e --check config.js
603-
jq empty toc_en.json
604-
605-
```shell
606602
:::
607-
```
603+
:::
608604

609605
If the CI checks fail, review the error messages and fix the issues before requesting a review.

docs/en/controllers/components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ class PostsController extends AppController
135135

136136
public function delete()
137137
{
138-
if ($this->Post->delete($this->request->getData('Post.id')) {
138+
if ($this->Post->delete($this->request->getData('Post.id'))) {
139139
$this->Flash->success('Post deleted.');
140140

141141
return $this->redirect(['action' => 'index']);
@@ -346,7 +346,7 @@ use Cake\Routing\Router;
346346

347347
public function beforeFilter(EventInterface $event): void
348348
{
349-
throw new RedirectException(Router::url('/'))
349+
throw new RedirectException(Router::url('/'));
350350
}
351351
```
352352

docs/en/controllers/middleware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
257257
If your application has cookies that contain data you want to obfuscate and
258258
protect against user tampering, you can use CakePHP's encrypted cookie
259259
middleware to transparently encrypt and decrypt cookie data via middleware.
260-
Cookie data is encrypted with via OpenSSL using AES:
260+
Cookie data is encrypted via OpenSSL using AES:
261261

262262
``` php
263263
use Cake\Http\Middleware\EncryptedCookieMiddleware;

docs/en/core-libraries/email.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ you want the filenames to appear in the recipient's mail client:
304304

305305
You can also add attachments using the `addAttachment()` method.
306306

307-
> \$mailer-\>addAttachment('/full/file/path/file.png');
307+
> `$mailer->addAttachment('/full/file/path/file.png');`
308308

309309
### Relaxing Address Validation Rules
310310

@@ -398,7 +398,7 @@ class UsersController extends AppController
398398
{
399399
$user = $this->Users->newEmptyEntity();
400400
if ($this->request->is('post')) {
401-
$user = $this->Users->patchEntity($user, $this->request->getData())
401+
$user = $this->Users->patchEntity($user, $this->request->getData());
402402
if ($this->Users->save($user)) {
403403
$this->getMailer('User')->send('welcome', [$user]);
404404
}

docs/en/core-libraries/registry-objects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ for Helpers, Behaviors, and Tasks in addition to Components.
99

1010
## Loading Objects
1111

12-
Objects can be loaded on-the-fly using add\<registry-object\>()
12+
Objects can be loaded on-the-fly using `add<registry-object>()`
1313
Example:
1414

1515
``` php

docs/en/core-libraries/text.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,8 @@ echo Text::highlight(
287287

288288
Output:
289289

290-
> Highlights \$phrase in \$text \<span class="highlight"\>using\</span\> the
291-
> \$options\['format'\] string specified or a default string.
290+
> Highlights `$phrase` in `$text` `<span class="highlight">using</span>` the
291+
> `$options['format']` string specified or a default string.
292292
293293
## Truncating Text
294294

0 commit comments

Comments
 (0)