Skip to content

Commit 4719d56

Browse files
authored
docs(k8s): fixed typos (#87)
1 parent 594e38a commit 4719d56

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

scaleway-async/scaleway_async/k8s/v1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,15 +213,15 @@ async def create_cluster(
213213
apiserver_cert_sans: Optional[List[str]] = None,
214214
) -> Cluster:
215215
"""
216-
Creates a new Kubernetes cluster on a Scaleway account.
216+
Create a new Kubernetes cluster on a Scaleway account.
217217
:param region: Region to target. If none is passed will use default region from the config.
218218
:param organization_id: Organization ID in which the cluster will be created.
219219
220220
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
221-
:param project_id: Poject ID in which the cluster will be created.
221+
:param project_id: Project ID in which the cluster will be created.
222222
223223
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
224-
:param type_: The type of the cluster (possible values are kapsule, multicloud).
224+
:param type_: Type of the cluster (possible values are kapsule, multicloud).
225225
:param name: Name of the cluster.
226226
:param description: Description of the cluster.
227227
:param tags: Tags associated with the cluster.
@@ -430,7 +430,7 @@ async def delete_cluster(
430430
region: Optional[Region] = None,
431431
) -> Cluster:
432432
"""
433-
Deletes a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
433+
Delete a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
434434
:param region: Region to target. If none is passed will use default region from the config.
435435
:param cluster_id: ID of the cluster to delete.
436436
:param with_additional_resources: Set true if you want to delete all volumes (including retain volume type) and loadbalancers whose name start with cluster ID.
@@ -470,7 +470,7 @@ async def upgrade_cluster(
470470
region: Optional[Region] = None,
471471
) -> Cluster:
472472
"""
473-
Upgrades a specific Kubernetes cluster and/or its associated pools to a specific and supported Kubernetes version.
473+
Upgrade a specific Kubernetes cluster and/or its associated pools to a specific and supported Kubernetes version.
474474
:param region: Region to target. If none is passed will use default region from the config.
475475
:param cluster_id: ID of the cluster to upgrade.
476476
:param version: New Kubernetes version of the cluster. Note that the version shoud either be a higher patch version of the same minor version or the direct minor version after the current one.

scaleway-async/scaleway_async/k8s/v1/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ class Cluster:
193193

194194
name: str
195195
"""
196-
Nqme of the cluster.
196+
Name of the cluster.
197197
"""
198198

199199
status: ClusterStatus
@@ -1191,14 +1191,14 @@ class CreateClusterRequest:
11911191

11921192
project_id: Optional[str]
11931193
"""
1194-
Poject ID in which the cluster will be created.
1194+
Project ID in which the cluster will be created.
11951195
11961196
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
11971197
"""
11981198

11991199
type_: str
12001200
"""
1201-
The type of the cluster (possible values are kapsule, multicloud).
1201+
Type of the cluster (possible values are kapsule, multicloud).
12021202
"""
12031203

12041204
name: Optional[str]

scaleway/scaleway/k8s/v1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,15 +213,15 @@ def create_cluster(
213213
apiserver_cert_sans: Optional[List[str]] = None,
214214
) -> Cluster:
215215
"""
216-
Creates a new Kubernetes cluster on a Scaleway account.
216+
Create a new Kubernetes cluster on a Scaleway account.
217217
:param region: Region to target. If none is passed will use default region from the config.
218218
:param organization_id: Organization ID in which the cluster will be created.
219219
220220
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
221-
:param project_id: Poject ID in which the cluster will be created.
221+
:param project_id: Project ID in which the cluster will be created.
222222
223223
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
224-
:param type_: The type of the cluster (possible values are kapsule, multicloud).
224+
:param type_: Type of the cluster (possible values are kapsule, multicloud).
225225
:param name: Name of the cluster.
226226
:param description: Description of the cluster.
227227
:param tags: Tags associated with the cluster.
@@ -430,7 +430,7 @@ def delete_cluster(
430430
region: Optional[Region] = None,
431431
) -> Cluster:
432432
"""
433-
Deletes a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
433+
Delete a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
434434
:param region: Region to target. If none is passed will use default region from the config.
435435
:param cluster_id: ID of the cluster to delete.
436436
:param with_additional_resources: Set true if you want to delete all volumes (including retain volume type) and loadbalancers whose name start with cluster ID.
@@ -470,7 +470,7 @@ def upgrade_cluster(
470470
region: Optional[Region] = None,
471471
) -> Cluster:
472472
"""
473-
Upgrades a specific Kubernetes cluster and/or its associated pools to a specific and supported Kubernetes version.
473+
Upgrade a specific Kubernetes cluster and/or its associated pools to a specific and supported Kubernetes version.
474474
:param region: Region to target. If none is passed will use default region from the config.
475475
:param cluster_id: ID of the cluster to upgrade.
476476
:param version: New Kubernetes version of the cluster. Note that the version shoud either be a higher patch version of the same minor version or the direct minor version after the current one.

scaleway/scaleway/k8s/v1/types.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ class Cluster:
193193

194194
name: str
195195
"""
196-
Nqme of the cluster.
196+
Name of the cluster.
197197
"""
198198

199199
status: ClusterStatus
@@ -1191,14 +1191,14 @@ class CreateClusterRequest:
11911191

11921192
project_id: Optional[str]
11931193
"""
1194-
Poject ID in which the cluster will be created.
1194+
Project ID in which the cluster will be created.
11951195
11961196
One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
11971197
"""
11981198

11991199
type_: str
12001200
"""
1201-
The type of the cluster (possible values are kapsule, multicloud).
1201+
Type of the cluster (possible values are kapsule, multicloud).
12021202
"""
12031203

12041204
name: Optional[str]

0 commit comments

Comments
 (0)