21123: the empty string -> an empty string
authorTom Clegg <tom@curii.com>
Wed, 13 Mar 2024 13:36:35 +0000 (09:36 -0400)
committerTom Clegg <tom@curii.com>
Wed, 13 Mar 2024 13:36:35 +0000 (09:36 -0400)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

doc/api/dispatch.html.textile.liquid
doc/api/methods/container_requests.html.textile.liquid
doc/sdk/python/cookbook.html.textile.liquid
lib/config/config.default.yml
sdk/python/arvados/events.py

index 7a916f064693fc9ae643072f82677d41cd827e8a..cfe57640c4785cca1c5ca4df4faadbd8cea996b1 100644 (file)
@@ -32,7 +32,7 @@ Return a list of containers that are either ready to dispatch, or being started/
 Each entry in the returned list of @items@ includes:
 * an @instance_type@ entry with the name and attributes of the instance type that will be used to schedule the container (chosen from the @InstanceTypes@ section of your cluster config file); and
 * a @container@ entry with selected attributes of the container itself, including @uuid@, @priority@, @runtime_constraints@, and @state@. Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@).
-* a @scheduling_status@ field with a brief explanation of the container's status in the dispatch queue, or the empty string if scheduling is not applicable, e.g., the container has already started running.
+* a @scheduling_status@ field with a brief explanation of the container's status in the dispatch queue, or an empty string if scheduling is not applicable, e.g., the container has already started running.
 
 Example response:
 
index 130aa73c05f628c0236f14e2da4a459b5168b1b9..1c269fb3e613cf0c8d03c2ac99fbc25f20a9b7e7 100644 (file)
@@ -240,7 +240,7 @@ table(table table-bordered table-condensed).
 |_. Attribute|_. Type|_. Description|_. Examples|
 |uuid|string|The UUID of the container assigned to this request.||
 |state|string|The state of the container assigned to this request (see "container resource attributes":containers.html).||
-|scheduling_status|string|A brief explanation of the container's status in the dispatch queue, or the empty string if scheduling is not applicable, e.g., the container is running or finished.|@waiting for cloud resources: queue position 3@
+|scheduling_status|string|A brief explanation of the container's status in the dispatch queue, or an empty string if scheduling is not applicable, e.g., the container is running or finished.|@waiting for cloud resources: queue position 3@
 @creating new instance@
 @preparing runtime environment@|
 
index c9e1f05f17567a76c362c4b7d5968a0d3352854a..d7d34fc0b0aa91221b26f38282dd85642559f73e 100644 (file)
@@ -498,7 +498,7 @@ dst_collection.copy(
     # The path of the source file or directory to copy
     'ExamplePath',
     # The path where the source file or directory will be copied.
-    # Pass the empty string like this to copy it to the same path.
+    # Pass an empty string like this to copy it to the same path.
     '',
     # The collection where the source file or directory comes from.
     # If not specified, the default is the current collection (so you'll
index e3b67f725932a8f899e95354064a3b10e6977fe0..fa74e8e6c6d52a37ee50f36efa0cf7626086a43e 100644 (file)
@@ -863,7 +863,7 @@ Clusters:
         # OpenID claim field containing the email verification
         # flag. Normally "email_verified".  To accept every returned
         # email address without checking a "verified" field at all,
-        # use the empty string "".
+        # use an empty string "".
         EmailVerifiedClaim: "email_verified"
 
         # OpenID claim field containing the user's preferred
@@ -1561,7 +1561,7 @@ Clusters:
         # container runner/supervisor. The default value is the
         # dispatcher program itself.
         #
-        # Use the empty string to disable this step: nothing will be
+        # Use an empty string to disable this step: nothing will be
         # copied, and cloud instances are assumed to have a suitable
         # version of crunch-run installed; see CrunchRunCommand above.
         DeployRunnerBinary: "/proc/self/exe"
index 917c876706ffb2bcab4189d5fca1da430b37a1fc..88a916e659e54643468536a11c94474ccb2ee3d0 100644 (file)
@@ -162,7 +162,7 @@ class EventClient(threading.Thread):
           disconnecting. Default 1000.
 
         * reason: str --- The WebSocket close reason sent to the server when
-          disconnecting. Default is the empty string.
+          disconnecting. Default is an empty string.
 
         * timeout: float --- How long to wait for the WebSocket server to
           acknowledge the disconnection, in seconds. Default 0, which means