Skip to content

Commit 6ad2baf

Browse files
authored
Merge pull request #8247 from cakephp/fix/definition-lists
Fix definition list formatting after Markdown migration
2 parents ee526df + 2e72b69 commit 6ad2baf

File tree

7 files changed

+192
-247
lines changed

7 files changed

+192
-247
lines changed

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

Lines changed: 12 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -411,40 +411,18 @@ be preceded by a newline.
411411

412412
Variable types for use in DocBlocks:
413413

414-
Type
415-
Description
416-
417-
mixed
418-
A variable with undefined (or multiple) type.
419-
420-
int
421-
Integer type variable (whole number).
422-
423-
float
424-
Float type (point number).
425-
426-
bool
427-
Logical type (true or false).
428-
429-
string
430-
String type (any value in " " or ' ').
431-
432-
null
433-
Null type. Usually used in conjunction with another type.
434-
435-
array
436-
Array type.
437-
438-
object
439-
Object type. A specific class name should be used if possible.
440-
441-
resource
442-
Resource type (returned by for example mysql_connect()).
443-
Remember that when you specify the type as mixed, you should indicate
444-
whether it is unknown, or what the possible types are.
445-
446-
callable
447-
Callable function.
414+
| Type | Description |
415+
|------|-------------|
416+
| mixed | A variable with undefined (or multiple) type. |
417+
| int | Integer type variable (whole number). |
418+
| float | Float type (point number). |
419+
| bool | Logical type (true or false). |
420+
| string | String type (any value in " " or ' '). |
421+
| null | Null type. Usually used in conjunction with another type. |
422+
| array | Array type. |
423+
| object | Object type. A specific class name should be used if possible. |
424+
| resource | Resource type (returned by for example mysql_connect()). Remember that when you specify the type as mixed, you should indicate whether it is unknown, or what the possible types are. |
425+
| callable | Callable function. |
448426

449427
You can also combine types using the pipe char:
450428

docs/en/controllers/request-response.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -782,12 +782,12 @@ $response = $this->response->withFile(
782782
The supported options are:
783783

784784
name
785-
The name allows you to specify an alternate file name to be sent to
786-
the user.
785+
: The name allows you to specify an alternate file name to be sent to
786+
the user.
787787

788788
download
789-
A boolean value indicating whether headers should be set to force
790-
download.
789+
: A boolean value indicating whether headers should be set to force
790+
download.
791791

792792
### Sending a String as a File
793793

docs/en/core-libraries/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ more information.
467467
`static` Cake\\Log\\Log::**configured**(): array
468468

469469
returns
470-
An array of configured loggers.
470+
: An array of configured loggers.
471471

472472
Get the names of the configured loggers.
473473

docs/en/development/configuration.md

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ Below is a description of the variables and how they affect your CakePHP
8787
application.
8888

8989
debug
90-
Changes CakePHP debugging output. `false` = Production mode. No error
91-
messages, errors, or warnings shown. `true` = Errors and warnings shown.
90+
: Changes CakePHP debugging output. `false` = Production mode. No error
91+
messages, errors, or warnings shown. `true` = Errors and warnings shown.
9292

9393
App.namespace
94-
The namespace to find app classes under.
94+
: The namespace to find app classes under.
9595

9696
> [!NOTE]
9797
> When changing the namespace in your configuration, you will also
@@ -102,78 +102,77 @@ The namespace to find app classes under.
102102
<div id="core-configuration-baseurl">
103103

104104
App.baseUrl
105-
Un-comment this definition if you **dont** plan to use Apaches
106-
mod_rewrite with CakePHP. Dont forget to remove your .htaccess
107-
files too.
105+
: Un-comment this definition if you **don't** plan to use Apache's
106+
mod_rewrite with CakePHP. Don't forget to remove your .htaccess
107+
files too.
108108

109109
App.base
110-
The base directory the app resides in. If `false` this
111-
will be auto detected. If not `false`, ensure your string starts
112-
with a `/` and does NOT end with a `/`. For example, `/basedir` is a valid
113-
App.base.
110+
: The base directory the app resides in. If `false` this
111+
will be auto detected. If not `false`, ensure your string starts
112+
with a `/` and does NOT end with a `/`. For example, `/basedir` is a valid
113+
App.base.
114114

115115
App.encoding
116-
Define what encoding your application uses. This encoding
117-
is used to generate the charset in the layout, and encode entities.
118-
It should match the encoding values specified for your database.
116+
: Define what encoding your application uses. This encoding
117+
is used to generate the charset in the layout, and encode entities.
118+
It should match the encoding values specified for your database.
119119

120120
App.webroot
121-
The webroot directory.
121+
: The webroot directory.
122122

123123
App.wwwRoot
124-
The file path to webroot.
124+
: The file path to webroot.
125125

126126
App.fullBaseUrl
127-
The fully qualified domain name (including protocol) to your application's
128-
root. This is used when generating absolute URLs. By default, this value
129-
is generated using the `$_SERVER` environment. However, you should define it
130-
manually to optimize performance or if you are concerned about people
131-
manipulating the `Host` header.
132-
In a CLI context (from command) the `fullBaseUrl` cannot be read from $_SERVER,
133-
as there is no webserver involved. You do need to specify it yourself if
134-
you do need to generate URLs from a shell (for example, when sending emails).
127+
: The fully qualified domain name (including protocol) to your application's
128+
root. This is used when generating absolute URLs. By default, this value
129+
is generated using the `$_SERVER` environment. However, you should define it
130+
manually to optimize performance or if you are concerned about people
131+
manipulating the `Host` header.
132+
In a CLI context (from command) the `fullBaseUrl` cannot be read from $_SERVER,
133+
as there is no webserver involved. You do need to specify it yourself if
134+
you do need to generate URLs from a shell (for example, when sending emails).
135135

136136
App.imageBaseUrl
137-
Web path to the public images directory under webroot. If you are using
138-
a `CDN` you should set this value to the CDN's location.
137+
: Web path to the public images directory under webroot. If you are using
138+
a `CDN` you should set this value to the CDN's location.
139139

140140
App.cssBaseUrl
141-
Web path to the public css directory under webroot. If you are using
142-
a `CDN` you should set this value to the CDN's location.
141+
: Web path to the public css directory under webroot. If you are using
142+
a `CDN` you should set this value to the CDN's location.
143143

144144
App.jsBaseUrl
145-
Web path to the public js directory under webroot. If you are using
146-
a `CDN` you should set this value to the CDN's location.
145+
: Web path to the public js directory under webroot. If you are using
146+
a `CDN` you should set this value to the CDN's location.
147147

148148
App.paths
149-
Configure paths for non class based resources. Supports the
150-
`plugins`, `templates`, `locales` subkeys, which allow the definition
151-
of paths for plugins, view templates and locale files respectively.
149+
: Configure paths for non class based resources. Supports the
150+
`plugins`, `templates`, `locales` subkeys, which allow the definition
151+
of paths for plugins, view templates and locale files respectively.
152152

153153
App.uploadedFilesAsObjects
154-
Defines whether uploaded files are being represented as objects (`true`),
155-
or arrays (`false`). This option is being treated as enabled by default.
156-
See the [File Uploads section](../controllers/request-response#request-file-uploads) in the Request &
157-
Response Objects chapter for more information.
154+
: Defines whether uploaded files are being represented as objects (`true`),
155+
or arrays (`false`). This option is being treated as enabled by default.
156+
See the [File Uploads section](../controllers/request-response#request-file-uploads) in the Request &
157+
Response Objects chapter for more information.
158158

159159
Security.salt
160-
A random string used in hashing. This value is also used as the
161-
HMAC salt when doing symmetric encryption.
160+
: A random string used in hashing. This value is also used as the
161+
HMAC salt when doing symmetric encryption.
162162

163163
Asset.timestamp
164-
Appends a timestamp which is last modified time of the particular
165-
file at the end of asset files URLs (CSS, JavaScript, Image) when
166-
using proper helpers. Valid values:
167-
168-
- (bool) `false` - Doesn't do anything (default)
169-
- (bool) `true` - Appends the timestamp when debug is `true`
170-
- (string) 'force' - Always appends the timestamp.
164+
: Appends a timestamp which is last modified time of the particular
165+
file at the end of asset files URLs (CSS, JavaScript, Image) when
166+
using proper helpers. Valid values:
167+
(bool) `false` - Doesn't do anything (default),
168+
(bool) `true` - Appends the timestamp when debug is `true`,
169+
(string) 'force' - Always appends the timestamp.
171170

172171
Asset.cacheTime
173-
Sets the asset cache time. This determines the http header `Cache-Control`'s
174-
`max-age`, and the http header's `Expire`'s time for assets.
175-
This can take anything that you version of PHP's [strtotime function](https://php.net/manual/en/function.strtotime.php) can take.
176-
The default is `+1 day`.
172+
: Sets the asset cache time. This determines the http header `Cache-Control`'s
173+
`max-age`, and the http header's `Expire`'s time for assets.
174+
This can take anything that you version of PHP's [strtotime function](https://php.net/manual/en/function.strtotime.php) can take.
175+
The default is `+1 day`.
177176

178177
</div>
179178

0 commit comments

Comments
 (0)