Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 828d477

Browse files
committed
docs/reference: explain "colon"
Colon may not be something non-native English readers know about, so explain the symbol in the running text. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit e34c407516eeed9ade6084048c546068c84cc847) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: de12dbfb16d4dc4c8d147f79008d255715c3de8f Component: cli
1 parent aa60834 commit 828d477

19 files changed

Lines changed: 21 additions & 19 deletions

components/cli/docs/reference/commandline/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ user credentials, VPN's, and so forth.
8484
> the repository and its submodules using a `git clone --recursive` command.
8585
8686
Git URLs accept context configuration in their fragment section, separated by a
87-
colon `:`. The first part represents the reference that Git will check out,
87+
colon (`:`). The first part represents the reference that Git will check out,
8888
and can be either a branch, a tag, or a remote reference. The second part
8989
represents a subdirectory inside the repository that will be used as a build
9090
context.

components/cli/docs/reference/commandline/history.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ output the data exactly as the template declares or, when using the
6868
`table` directive, will include column headers as well.
6969

7070
The following example uses a template without headers and outputs the
71-
`ID` and `CreatedSince` entries separated by a colon for the `busybox` image:
71+
`ID` and `CreatedSince` entries separated by a colon (`:`) for the `busybox`
72+
image:
7273

7374
```bash
7475
$ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox

components/cli/docs/reference/commandline/images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ output the data exactly as the template declares or, when using the
308308
`table` directive, will include column headers as well.
309309

310310
The following example uses a template without headers and outputs the
311-
`ID` and `Repository` entries separated by a colon for all images:
311+
`ID` and `Repository` entries separated by a colon (`:`) for all images:
312312

313313
```bash
314314
$ docker images --format "{{.ID}}: {{.Repository}}"

components/cli/docs/reference/commandline/network_ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ output the data exactly as the template declares or, when using the
221221
`table` directive, includes column headers as well.
222222

223223
The following example uses a template without headers and outputs the
224-
`ID` and `Driver` entries separated by a colon for all networks:
224+
`ID` and `Driver` entries separated by a colon (`:`) for all networks:
225225

226226
```bash
227227
$ docker network ls --format "{{.ID}}: {{.Driver}}"

components/cli/docs/reference/commandline/node_ls.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ output the data exactly as the template declares or, when using the
152152
`table` directive, includes column headers as well.
153153

154154
The following example uses a template without headers and outputs the
155-
`ID`, `Hostname`, and `TLS Status` entries separated by a colon for all nodes:
155+
`ID`, `Hostname`, and `TLS Status` entries separated by a colon (`:`) for all
156+
nodes:
156157

157158
```bash
158159
$ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}"

components/cli/docs/reference/commandline/node_ps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ output the data exactly as the template declares or, when using the
130130
`table` directive, includes column headers as well.
131131

132132
The following example uses a template without headers and outputs the
133-
`Name` and `Image` entries separated by a colon for all tasks:
133+
`Name` and `Image` entries separated by a colon (`:`) for all tasks:
134134

135135
```bash
136136
$ docker node ps --format "{{.Name}}: {{.Image}}"

components/cli/docs/reference/commandline/plugin_ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ output the data exactly as the template declares or, when using the
8888
`table` directive, includes column headers as well.
8989

9090
The following example uses a template without headers and outputs the
91-
`ID` and `Name` entries separated by a colon for all plugins:
91+
`ID` and `Name` entries separated by a colon (`:`) for all plugins:
9292

9393
```bash
9494
$ docker plugin ls --format "{{.ID}}: {{.Name}}"

components/cli/docs/reference/commandline/ps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ exactly as the template declares or, when using the `table` directive, includes
420420
column headers as well.
421421

422422
The following example uses a template without headers and outputs the `ID` and
423-
`Command` entries separated by a colon for all running containers:
423+
`Command` entries separated by a colon (`:`) for all running containers:
424424

425425
```bash
426426
$ docker ps --format "{{.ID}}: {{.Command}}"

components/cli/docs/reference/commandline/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ output the data exactly as the template declares. If you use the
152152
`table` directive, column headers are included as well.
153153

154154
The following example uses a template without headers and outputs the
155-
`Name` and `StarCount` entries separated by a colon for all images:
155+
`Name` and `StarCount` entries separated by a colon (`:`) for all images:
156156

157157
```bash
158158
$ docker search --format "{{.Name}}: {{.StarCount}}" nginx

components/cli/docs/reference/commandline/secret_ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ output the data exactly as the template declares or, when using the
126126
`table` directive, will include column headers as well.
127127

128128
The following example uses a template without headers and outputs the
129-
`ID` and `Name` entries separated by a colon for all images:
129+
`ID` and `Name` entries separated by a colon (`:`) for all images:
130130

131131
```bash
132132
$ docker secret ls --format "{{.ID}}: {{.Name}}"

0 commit comments

Comments
 (0)