Skip to content

Commit c7237e0

Browse files
doc/configuration: use consistent optional notation for arguments
Signed-off-by: Bastian Krause <bst@pengutronix.de>
1 parent ad07f49 commit c7237e0

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

doc/configuration.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -519,9 +519,9 @@ Arguments:
519519
- body_deasserted (str): Request body to send to de-assert the output
520520
- method (str, default="PUT"): HTTP method to set a new state
521521

522-
- url_get (str): URL to use instead of ``url`` for getting the state
523-
- body_get_asserted (str): Regular Expression that matches an asserted response body
524-
- body_get_deasserted (str): Regular Expression that matches a de-asserted response body
522+
- url_get (str): optional, URL to use instead of ``url`` for getting the state
523+
- body_get_asserted (str): optional, regular expression that matches an asserted response body
524+
- body_get_deasserted (str): optional, regular expression that matches a de-asserted response body
525525

526526
Used by:
527527
- `HttpDigitalOutputDriver`_
@@ -1197,7 +1197,7 @@ Arguments:
11971197
ASRL, TCPIP...
11981198
- url (str): device identifier on selected resource, e.g. <ip> for TCPIP
11991199
resource
1200-
- backend (str): Visa library backend, e.g. '@sim' for pyvisa-sim backend
1200+
- backend (str): optional, Visa library backend, e.g. '@sim' for pyvisa-sim backend
12011201

12021202
Used by:
12031203
- `PyVISADriver`_
@@ -3081,10 +3081,10 @@ Implements:
30813081
30823082
Arguments:
30833083
- image_uri (str): identifier of the docker image to use (may have a tag suffix)
3084-
- command (str): command to run in the container (optional, depends on image)
3085-
- volumes (list): list to configure volumes mounted inside the container (optional)
3084+
- command (str): optional, command to run in the container (depends on image)
3085+
- volumes (list): optional, list to configure volumes mounted inside the container
30863086
- container_name (str): name of the container
3087-
- environment (list): list of environment variables (optional)
3087+
- environment (list): optional, list of environment variables
30883088
- host_config (dict): dictionary of host configurations
30893089
- network_services (list): dictionaries that describe individual `NetworkService`_
30903090
instances that come alive when the container is created. The "address" argument

0 commit comments

Comments
 (0)