Skip to content

Commit 6d972ff

Browse files
thaJeztahthaJeztah
committed
Improve example for env vars in API docs
This was added in e41de3e, but can be a bit confusing due to the "outer" brackets being for JSON, and the "inner" brackets to indicate optional values. During review of that change, this alternative format was suggested. Updating the example to use the format that was discussed during review :) Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 441c941) Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 39466e3 commit 6d972ff

8 files changed

Lines changed: 8 additions & 8 deletions

‎docs/reference/api/docker_remote_api_v1.18.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ Create a container
211211
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
212212
- **OpenStdin** - Boolean value, opens `stdin`,
213213
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
214-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
214+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
215215
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
216216
- **Cmd** - Command to run specified as a string or an array of strings.
217217
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.19.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Create a container
216216
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
217217
- **OpenStdin** - Boolean value, opens `stdin`,
218218
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
219-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
219+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
220220
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
221221
- **Cmd** - Command to run specified as a string or an array of strings.
222222
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.20.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Create a container
218218
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
219219
- **OpenStdin** - Boolean value, opens `stdin`,
220220
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
221-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
221+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
222222
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
223223
- **Cmd** - Command to run specified as a string or an array of strings.
224224
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.21.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Create a container
227227
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
228228
- **OpenStdin** - Boolean value, opens `stdin`,
229229
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
230-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
230+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
231231
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
232232
- **Cmd** - Command to run specified as a string or an array of strings.
233233
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.22.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ Create a container
330330
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
331331
- **OpenStdin** - Boolean value, opens `stdin`,
332332
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
333-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
333+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
334334
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
335335
- **Cmd** - Command to run specified as a string or an array of strings.
336336
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.23.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Create a container
353353
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
354354
- **OpenStdin** - Boolean value, opens `stdin`,
355355
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
356-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
356+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
357357
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
358358
- **Cmd** - Command to run specified as a string or an array of strings.
359359
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.24.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Create a container
370370
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
371371
- **OpenStdin** - Boolean value, opens `stdin`,
372372
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
373-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
373+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
374374
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
375375
- **Cmd** - Command to run specified as a string or an array of strings.
376376
- **Entrypoint** - Set the entry point for the container as a string or an array

‎docs/reference/api/docker_remote_api_v1.25.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ Create a container
372372
- **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed.
373373
- **OpenStdin** - Boolean value, opens `stdin`,
374374
- **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects.
375-
- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]`
375+
- **Env** - A list of environment variables in the form of `["VAR=value", ...]`
376376
- **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}`
377377
- **Cmd** - Command to run specified as a string or an array of strings.
378378
- **Entrypoint** - Set the entry point for the container as a string or an array

0 commit comments

Comments
 (0)