Skip to content

Commit fb4bdec

Browse files
authored
Fix RST-to-Markdown conversion artifacts across English docs (#8203)
* Fix RST-to-Markdown conversion artifacts across English docs - Replace all <span class="title-ref"> artifacts with backtick code - Remove trailing ` :` and `.:` RST directive artifacts - Remove orphan/True RST metadata from 404.md, epub-contents.md, pdf-contents.md - Remove leftover <div class="index"> and <div class="todolist"> blocks - Fix wrong code block language tags (css/javascript used for PHP code) - Fix escaped RST syntax (\*\*, =\>, \\$, double backticks) - Fix broken :ref: link in 5-3-migration-guide.md - Fix broken RST cross-reference in console-commands/commands.md * Fix broken Command Helpers link in commands.md.
1 parent 5eb4a07 commit fb4bdec

45 files changed

Lines changed: 107 additions & 202 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/en/404.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
orphan
2-
True
3-
41
# Not Found
52

63
The page you're looking for cannot be found. Try using the search bar to find

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ changes made:
4646

4747
### Auth
4848

49-
- <span class="title-ref">Auth</span> has been removed. Use the [cakephp/authentication](https://book.cakephp.org/authentication/3/en/index.html) and
49+
- `Auth` has been removed. Use the [cakephp/authentication](https://book.cakephp.org/authentication/3/en/index.html) and
5050
[cakephp/authorization](https://book.cakephp.org/authorization/3/en/index.html) plugins instead.
5151

5252
### Cache
@@ -166,7 +166,7 @@ changes made:
166166

167167
### I18n
168168

169-
- `FrozenDate` was renamed to <span class="title-ref">Date</span> and `FrozenTime` was renamed to <span class="title-ref">DateTime</span>.
169+
- `FrozenDate` was renamed to `Date` and `FrozenTime` was renamed to `DateTime`.
170170
- `Time` now extends `Cake\Chronos\ChronosTime` and is therefore immutable.
171171
- `Date` objects do not extend `DateTimeInterface` anymore - therefore you can't compare them with `DateTime` objects.
172172
See the [cakephp/chronos release documentation](https://github.com/cakephp/chronos/releases/tag/3.0.2) for more information.

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

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

121121
- Added `Configure` attribute to support injecting `Configure` values into
122-
constructor arguments. See ref:\`configure-dependency-injection\`.
122+
constructor arguments. See [Configure Dependency Injection](../development/dependency-injection#configure-dependency-injection).
123123

124124
### Database
125125

docs/en/appendices/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A generic term used to describe both entity properties, or database
5454
columns. Often used in conjunction with the FormHelper.
5555

5656
HTML attributes
57-
An array of key =\> values that are composed into HTML attributes. For example:
57+
An array of key => values that are composed into HTML attributes. For example:
5858

5959
``` php
6060
// Given

docs/en/console-commands/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Commands are provided a `ConsoleIo` instance when executed. This object allows
143143
you to interact with `Cake\Console\ConsoleIo::out()` and
144144
`Cake\Console\ConsoleIo::err()` to emit on `stdout`, and
145145
`stderr`. Files can be created with overwrite confirmation with
146-
`Cake\Console\ConsoleIo::createFile()`<span class="title-ref">. :ref:\`command-helpers</span>
146+
`Cake\Console\ConsoleIo::createFile()`. [Command Helpers](../console-commands/input-output#command-helpers)
147147
provide 'macros' for output generation. See the
148148
[Command Input/Output](../console-commands/input-output) section for more information.
149149

docs/en/console-commands/cron-jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ trivial to setup, for example:
2020
You can see more info here: <https://en.wikipedia.org/wiki/Cron>
2121

2222
> [!TIP]
23-
> Use `-q` (or <span class="title-ref">--quiet</span>) to silence any output for cronjobs.
23+
> Use `-q` (or `--quiet`) to silence any output for cronjobs.
2424
2525
## Cron Jobs on Shared Hosting
2626

docs/en/console-commands/option-parsers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The `separator` option was added.
7676
`method` Cake\\Console\\ConsoleOptionParser::**addArguments**(array $args): static
7777

7878
If you have an array with multiple arguments you can use
79-
`$parser->addArguments()` to add multiple arguments at once. :
79+
`$parser->addArguments()` to add multiple arguments at once.
8080

8181
``` php
8282
$parser->addArguments([
@@ -167,7 +167,7 @@ The `separator` option was added.
167167
`method` Cake\\Console\\ConsoleOptionParser::**addOptions**(array $options): static
168168

169169
If you have an array with multiple options you can use `$parser->addOptions()`
170-
to add multiple options at once. :
170+
to add multiple options at once.
171171

172172
``` php
173173
$parser->addOptions([

docs/en/contents.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,3 @@
7373

7474
- [Constants & Functions](core-libraries/global-constants-and-functions)
7575
- [Appendices](appendices)
76-
77-
<div class="todolist">
78-
79-
</div>

docs/en/contributing/cakephp-coding-conventions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,8 @@ public function foo($array)
325325
### Anonymous Functions (Closures)
326326

327327
Defining anonymous functions follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding style guide, where they are
328-
declared with a space after the <span class="title-ref">function</span> keyword, and a space before and after
329-
the <span class="title-ref">use</span> keyword:
328+
declared with a space after the `function` keyword, and a space before and after
329+
the `use` keyword:
330330

331331
``` php
332332
$closure = function ($arg1, $arg2) use ($var1, $var2) {
@@ -507,7 +507,7 @@ The short echo tag (`<?=`) is always available regardless of the `short_open_tag
507507

508508
Write all functions in camelBack:
509509

510-
``` javascript
510+
``` php
511511
function longFunctionName()
512512
{
513513
}

docs/en/controllers/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ The above would pass the array containing precision and randomGenerator to
249249
### Using Other Components in your Component
250250

251251
Sometimes one of your components may need to use another component.
252-
You can load other components by adding them to the <span class="title-ref">\$components</span> property:
252+
You can load other components by adding them to the `$components` property:
253253

254254
``` php
255255
// src/Controller/Component/CustomComponent.php

0 commit comments

Comments
 (0)