Skip to content

Commit 65c1756

Browse files
docs(api): reword docstrings to present tense across resources
1 parent 852ef60 commit 65c1756

30 files changed

Lines changed: 213 additions & 248 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 75
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-fffea977331d642c3cde67d736d5e6fd461b2f9e5ecf9e282028a834b1a31a6e.yml
3-
openapi_spec_hash: c541c2196a5702cb5b66eddf261359c5
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai/togetherai-b584185aba41e3d597bf715d9b704f1c7d2663ae7d8f3f3c35e63d603738ee9c.yml
3+
openapi_spec_hash: 0b26ddf285392dd9f629c1161db62376
44
config_hash: 6c214c91fad5ead4849be777fd9e8108

src/together/resources/beta/clusters/clusters.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ def create(
144144
145145
reservation_start_time: Reservation start time of the cluster. This field is required for SCHEDULED
146146
billing to specify the reservation start time for the cluster. If not provided,
147-
the cluster will be provisioned immediately.
147+
the cluster provisions immediately.
148148
149149
shared_volume: Inline configuration to create a shared volume with the cluster creation.
150150
@@ -467,7 +467,7 @@ async def create(
467467
468468
reservation_start_time: Reservation start time of the cluster. This field is required for SCHEDULED
469469
billing to specify the reservation start time for the cluster. If not provided,
470-
the cluster will be provisioned immediately.
470+
the cluster provisions immediately.
471471
472472
shared_volume: Inline configuration to create a shared volume with the cluster creation.
473473

src/together/resources/beta/jig/jig.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def update(
166166
description: Description is an optional human-readable description of your deployment
167167
168168
environment_variables: EnvironmentVariables is a list of environment variables to set in the container.
169-
This will replace all existing environment variables
169+
Replaces all existing environment variables.
170170
171171
gpu_count: GPUCount is the number of GPUs to allocate per container instance
172172
@@ -196,8 +196,8 @@ def update(
196196
termination_grace_period_seconds: TerminationGracePeriodSeconds is the time in seconds to wait for graceful
197197
shutdown before forcefully terminating the replica
198198
199-
volumes: Volumes is a list of volume mounts to attach to the container. This will replace
200-
all existing volumes
199+
volumes: Volumes is a list of volume mounts to attach to the container. Replaces all
200+
existing volumes.
201201
202202
extra_headers: Send extra headers
203203
@@ -320,10 +320,10 @@ def deploy(
320320
if not specified
321321
322322
health_check_path: HealthCheckPath is the HTTP path for health checks (e.g., "/health"). If set,
323-
the platform will check this endpoint to determine container health
323+
the platform checks this endpoint to determine container health.
324324
325-
max_replicas: MaxReplicas is the maximum number of container instances that can be scaled up
326-
to. If not set, will be set to MinReplicas
325+
max_replicas: MaxReplicas is the maximum number of container instances. Defaults to
326+
MinReplicas if not set.
327327
328328
memory: Memory is the amount of RAM to allocate per container instance in GiB (e.g., 0.5
329329
= 512MiB)
@@ -576,7 +576,7 @@ async def update(
576576
description: Description is an optional human-readable description of your deployment
577577
578578
environment_variables: EnvironmentVariables is a list of environment variables to set in the container.
579-
This will replace all existing environment variables
579+
Replaces all existing environment variables.
580580
581581
gpu_count: GPUCount is the number of GPUs to allocate per container instance
582582
@@ -606,8 +606,8 @@ async def update(
606606
termination_grace_period_seconds: TerminationGracePeriodSeconds is the time in seconds to wait for graceful
607607
shutdown before forcefully terminating the replica
608608
609-
volumes: Volumes is a list of volume mounts to attach to the container. This will replace
610-
all existing volumes
609+
volumes: Volumes is a list of volume mounts to attach to the container. Replaces all
610+
existing volumes.
611611
612612
extra_headers: Send extra headers
613613
@@ -730,10 +730,10 @@ async def deploy(
730730
if not specified
731731
732732
health_check_path: HealthCheckPath is the HTTP path for health checks (e.g., "/health"). If set,
733-
the platform will check this endpoint to determine container health
733+
the platform checks this endpoint to determine container health.
734734
735-
max_replicas: MaxReplicas is the maximum number of container instances that can be scaled up
736-
to. If not set, will be set to MinReplicas
735+
max_replicas: MaxReplicas is the maximum number of container instances. Defaults to
736+
MinReplicas if not set.
737737
738738
memory: Memory is the amount of RAM to allocate per container instance in GiB (e.g., 0.5
739739
= 512MiB)

src/together/resources/beta/jig/secrets.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def create(
6565
characters)
6666
6767
value: Value is the sensitive data to store securely (e.g., API keys, passwords,
68-
tokens). This value will be encrypted at rest
68+
tokens). Encrypted at rest.
6969
7070
description: Description is an optional human-readable description of the secret's purpose
7171
(max 500 characters)
@@ -164,8 +164,8 @@ def update(
164164
project_id: ProjectID is ignored - the project is automatically determined from your
165165
authentication
166166
167-
value: Value is the new sensitive data to store securely. Updating this will replace
168-
the existing secret value
167+
value: Value is the new sensitive data to store securely. Updating this replaces the
168+
existing secret value.
169169
170170
extra_headers: Send extra headers
171171
@@ -292,7 +292,7 @@ async def create(
292292
characters)
293293
294294
value: Value is the sensitive data to store securely (e.g., API keys, passwords,
295-
tokens). This value will be encrypted at rest
295+
tokens). Encrypted at rest.
296296
297297
description: Description is an optional human-readable description of the secret's purpose
298298
(max 500 characters)
@@ -391,8 +391,8 @@ async def update(
391391
project_id: ProjectID is ignored - the project is automatically determined from your
392392
authentication
393393
394-
value: Value is the new sensitive data to store securely. Updating this will replace
395-
the existing secret value
394+
value: Value is the new sensitive data to store securely. Updating this replaces the
395+
existing secret value.
396396
397397
extra_headers: Send extra headers
398398

src/together/resources/beta/jig/volumes.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def create(
6161
Create a new volume to preload files in deployments
6262
6363
Args:
64-
content: Content specifies the new content that will be preloaded to this volume
64+
content: Content specifies the new content to preload to this volume.
6565
6666
name: Name is the unique identifier for the volume within the project
6767
@@ -146,7 +146,7 @@ def update(
146146
Args:
147147
id: Volume ID or name.
148148
149-
content: Content specifies the new content that will be preloaded to this volume
149+
content: Content specifies the new content to preload to this volume.
150150
151151
name: Name is the new unique identifier for the volume within the project
152152
@@ -270,7 +270,7 @@ async def create(
270270
Create a new volume to preload files in deployments
271271
272272
Args:
273-
content: Content specifies the new content that will be preloaded to this volume
273+
content: Content specifies the new content to preload to this volume.
274274
275275
name: Name is the unique identifier for the volume within the project
276276
@@ -355,7 +355,7 @@ async def update(
355355
Args:
356356
id: Volume ID or name.
357357
358-
content: Content specifies the new content that will be preloaded to this volume
358+
content: Content specifies the new content to preload to this volume.
359359
360360
name: Name is the new unique identifier for the volume within the project
361361

0 commit comments

Comments
 (0)