Skip to content

Commit fc7551d

Browse files
authored
docs: fix various spelling (#942)
1 parent 2b3b4fe commit fc7551d

File tree

32 files changed

+66
-66
lines changed

32 files changed

+66
-66
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ class Offer:
759759

760760
price_per_hour: Optional[Money]
761761
"""
762-
Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).
762+
Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
763763
"""
764764

765765
price_per_month: Optional[Money]

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,7 @@ class OfferSANInfo:
695695

696696
ha: bool
697697
"""
698-
High availabilty offer.
698+
High availability offer.
699699
"""
700700

701701
device_type: OfferSANInfoType
@@ -933,12 +933,12 @@ class OS:
933933

934934
requires_valid_hostname: Optional[bool]
935935
"""
936-
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
936+
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
937937
"""
938938

939939
hostname_regex: Optional[str]
940940
"""
941-
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
941+
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
942942
"""
943943

944944
released_at: Optional[datetime]

scaleway-async/scaleway_async/function/v1beta1/api.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ async def list_functions(
428428
:param page_size: Number of functions per page.
429429
:param order_by: Order of the functions.
430430
:param name: Name of the function.
431-
:param organization_id: UUID of the Organziation the function belongs to.
431+
:param organization_id: UUID of the Organization the function belongs to.
432432
:param project_id: UUID of the Project the function belongs to.
433433
:return: :class:`ListFunctionsResponse <ListFunctionsResponse>`
434434
@@ -482,7 +482,7 @@ async def list_functions_all(
482482
:param page_size: Number of functions per page.
483483
:param order_by: Order of the functions.
484484
:param name: Name of the function.
485-
:param organization_id: UUID of the Organziation the function belongs to.
485+
:param organization_id: UUID of the Organization the function belongs to.
486486
:param project_id: UUID of the Project the function belongs to.
487487
:return: :class:`List[Function] <List[Function]>`
488488
@@ -609,7 +609,7 @@ async def create_function(
609609
:param region: Region to target. If none is passed will use default region from the config.
610610
:param name: Name of the function to create.
611611
:param environment_variables: Environment variables of the function.
612-
:param min_scale: Minumum number of instances to scale the function to.
612+
:param min_scale: Minimum number of instances to scale the function to.
613613
:param max_scale: Maximum number of instances to scale the function to.
614614
:param runtime: Runtime to use with the function.
615615
:param memory_limit: Memory limit of the function in MB.
@@ -689,7 +689,7 @@ async def update_function(
689689
:param function_id: UUID of the function to update.
690690
:param region: Region to target. If none is passed will use default region from the config.
691691
:param environment_variables: Environment variables of the function to update.
692-
:param min_scale: Minumum number of instances to scale the function to.
692+
:param min_scale: Minimum number of instances to scale the function to.
693693
:param max_scale: Maximum number of instances to scale the function to.
694694
:param runtime: Runtime to use with the function.
695695
:param memory_limit: Memory limit of the function in MB.
@@ -1223,7 +1223,7 @@ async def list_domains(
12231223
"""
12241224
List all domain name bindings.
12251225
List all domain name bindings in a specified region.
1226-
:param function_id: UUID of the function the domain is assoicated with.
1226+
:param function_id: UUID of the function the domain is associated with.
12271227
:param region: Region to target. If none is passed will use default region from the config.
12281228
:param page: Page number.
12291229
:param page_size: Number of domains per page.
@@ -1268,7 +1268,7 @@ async def list_domains_all(
12681268
"""
12691269
List all domain name bindings.
12701270
List all domain name bindings in a specified region.
1271-
:param function_id: UUID of the function the domain is assoicated with.
1271+
:param function_id: UUID of the function the domain is associated with.
12721272
:param region: Region to target. If none is passed will use default region from the config.
12731273
:param page: Page number.
12741274
:param page_size: Number of domains per page.
@@ -1578,7 +1578,7 @@ async def list_tokens(
15781578
:param page: Page number.
15791579
:param page_size: Number of tokens per page.
15801580
:param order_by: Sort order for the tokens.
1581-
:param function_id: UUID of the function the token is assoicated with.
1581+
:param function_id: UUID of the function the token is associated with.
15821582
:param namespace_id: UUID of the namespace the token is associated with.
15831583
:return: :class:`ListTokensResponse <ListTokensResponse>`
15841584
@@ -1623,7 +1623,7 @@ async def list_tokens_all(
16231623
:param page: Page number.
16241624
:param page_size: Number of tokens per page.
16251625
:param order_by: Sort order for the tokens.
1626-
:param function_id: UUID of the function the token is assoicated with.
1626+
:param function_id: UUID of the function the token is associated with.
16271627
:param namespace_id: UUID of the namespace the token is associated with.
16281628
:return: :class:`List[Token] <List[Token]>`
16291629

scaleway-async/scaleway_async/function/v1beta1/types.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -815,7 +815,7 @@ class CreateFunctionRequest:
815815

816816
min_scale: Optional[int]
817817
"""
818-
Minumum number of instances to scale the function to.
818+
Minimum number of instances to scale the function to.
819819
"""
820820

821821
max_scale: Optional[int]
@@ -1206,7 +1206,7 @@ class ListCronsResponse:
12061206
class ListDomainsRequest:
12071207
function_id: str
12081208
"""
1209-
UUID of the function the domain is assoicated with.
1209+
UUID of the function the domain is associated with.
12101210
"""
12111211

12121212
region: Optional[ScwRegion]
@@ -1298,7 +1298,7 @@ class ListFunctionsRequest:
12981298

12991299
organization_id: Optional[str]
13001300
"""
1301-
UUID of the Organziation the function belongs to.
1301+
UUID of the Organization the function belongs to.
13021302
"""
13031303

13041304
project_id: Optional[str]
@@ -1392,7 +1392,7 @@ class ListTokensRequest:
13921392

13931393
function_id: Optional[str]
13941394
"""
1395-
UUID of the function the token is assoicated with.
1395+
UUID of the function the token is associated with.
13961396
"""
13971397

13981398
namespace_id: Optional[str]
@@ -1502,7 +1502,7 @@ class UpdateFunctionRequest:
15021502

15031503
min_scale: Optional[int]
15041504
"""
1505-
Minumum number of instances to scale the function to.
1505+
Minimum number of instances to scale the function to.
15061506
"""
15071507

15081508
max_scale: Optional[int]

scaleway-async/scaleway_async/iam/v1alpha1/api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1289,7 +1289,7 @@ async def get_group(
12891289
) -> Group:
12901290
"""
12911291
Get a group.
1292-
Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
1292+
Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
12931293
:param group_id: ID of the group.
12941294
:return: :class:`Group <Group>`
12951295
@@ -2249,7 +2249,7 @@ async def get_api_key(
22492249
) -> APIKey:
22502250
"""
22512251
Get an API key.
2252-
Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
2252+
Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
22532253
:param access_key: Access key to search for.
22542254
:return: :class:`APIKey <APIKey>`
22552255

scaleway-async/scaleway_async/inference/v1beta1/api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ async def delete_deployment_acl_rule(
725725
region: Optional[ScwRegion] = None,
726726
) -> None:
727727
"""
728-
Delete an exising ACL.
728+
Delete an existing ACL.
729729
:param acl_id: ID of the ACL rule to delete.
730730
:param region: Region to target. If none is passed will use default region from the config.
731731

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1253,7 +1253,7 @@ class Task:
12531253

12541254
zone: ScwZone
12551255
"""
1256-
Zone in which the task is excecuted.
1256+
Zone in which the task is executed.
12571257
"""
12581258

12591259
started_at: Optional[datetime]

scaleway-async/scaleway_async/interlink/v1beta1/api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -768,7 +768,7 @@ async def create_link(
768768
) -> Link:
769769
"""
770770
Create a link.
771-
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
771+
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
772772
:param name: Name of the link.
773773
:param pop_id: PoP (location) where the link will be created.
774774
:param bandwidth_mbps: Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ async def list_devices(
635635
:param order_by: Ordering of requested devices.
636636
:param name: Name to filter for, only devices with this name will be returned.
637637
:param hub_id: Hub ID to filter for, only devices attached to this Hub will be returned.
638-
:param allow_insecure: Defines wheter to filter the allow_insecure flag.
638+
:param allow_insecure: Defines whether to filter the allow_insecure flag.
639639
:param status: Device status (enabled, disabled, etc.).
640640
:return: :class:`ListDevicesResponse <ListDevicesResponse>`
641641
@@ -687,7 +687,7 @@ async def list_devices_all(
687687
:param order_by: Ordering of requested devices.
688688
:param name: Name to filter for, only devices with this name will be returned.
689689
:param hub_id: Hub ID to filter for, only devices attached to this Hub will be returned.
690-
:param allow_insecure: Defines wheter to filter the allow_insecure flag.
690+
:param allow_insecure: Defines whether to filter the allow_insecure flag.
691691
:param status: Device status (enabled, disabled, etc.).
692692
:return: :class:`List[Device] <List[Device]>`
693693

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,7 @@ class ListDevicesRequest:
10931093

10941094
allow_insecure: Optional[bool]
10951095
"""
1096-
Defines wheter to filter the allow_insecure flag.
1096+
Defines whether to filter the allow_insecure flag.
10971097
"""
10981098

10991099
status: Optional[DeviceStatus]

scaleway-async/scaleway_async/mongodb/v1alpha1/types.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ class NodeTypeVolumeType:
212212

213213
min_size: int
214214
"""
215-
Mimimum size required for the volume.
215+
Minimum size required for the volume.
216216
"""
217217

218218
max_size: int

scaleway-async/scaleway_async/qaas/v1alpha1/types.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ class Platform:
363363

364364
version: str
365365
"""
366-
Verison of the platform.
366+
Version of the platform.
367367
"""
368368

369369
name: str
@@ -408,7 +408,7 @@ class Platform:
408408

409409
price_per_hour: Optional[Money]
410410
"""
411-
Price to be payed per hour (excluding free tiers).
411+
Price to be paid per hour (excluding free tiers).
412412
"""
413413

414414
hardware: Optional[PlatformHardware]

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1958,7 +1958,7 @@ async def set_instance_settings(
19581958
) -> SetInstanceSettingsResponse:
19591959
"""
19601960
Set Database Instance advanced settings.
1961-
Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
1961+
Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
19621962
:param instance_id: UUID of the Database Instance where the settings must be set.
19631963
:param settings: Settings to define for the Database Instance.
19641964
:param region: Region to target. If none is passed will use default region from the config.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ class Volume:
606606
class NodeTypeVolumeConstraintSizes:
607607
min_size: int
608608
"""
609-
[deprecated] Mimimum size required for the Volume.
609+
[deprecated] Minimum size required for the Volume.
610610
"""
611611

612612
max_size: int
@@ -629,7 +629,7 @@ class NodeTypeVolumeType:
629629

630630
min_size: int
631631
"""
632-
Mimimum size required for the Volume.
632+
Minimum size required for the Volume.
633633
"""
634634

635635
max_size: int

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -837,7 +837,7 @@ async def set_cluster_settings(
837837
) -> ClusterSettingsResponse:
838838
"""
839839
Set advanced settings.
840-
Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
840+
Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.
841841
:param cluster_id: UUID of the Database Instance where the settings must be set.
842842
:param settings: Settings to define for the Database Instance.
843843
:param zone: Zone to target. If none is passed will use default zone from the config.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ class Namespace:
152152

153153
name: str
154154
"""
155-
Name of the namespace, unique in a region accross all organizations.
155+
Name of the namespace, unique in a region across all organizations.
156156
"""
157157

158158
description: str

scaleway/scaleway/baremetal/v1/types.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ class Offer:
759759

760760
price_per_hour: Optional[Money]
761761
"""
762-
Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32).
762+
Price of the offer for the next 60 minutes (a server order at 11h32 will be paid until 12h32).
763763
"""
764764

765765
price_per_month: Optional[Money]

scaleway/scaleway/dedibox/v1/types.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,7 @@ class OfferSANInfo:
695695

696696
ha: bool
697697
"""
698-
High availabilty offer.
698+
High availability offer.
699699
"""
700700

701701
device_type: OfferSANInfoType
@@ -933,12 +933,12 @@ class OS:
933933

934934
requires_valid_hostname: Optional[bool]
935935
"""
936-
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
936+
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
937937
"""
938938

939939
hostname_regex: Optional[str]
940940
"""
941-
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid.
941+
If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criteria must be valid.
942942
"""
943943

944944
released_at: Optional[datetime]

scaleway/scaleway/function/v1beta1/api.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ def list_functions(
426426
:param page_size: Number of functions per page.
427427
:param order_by: Order of the functions.
428428
:param name: Name of the function.
429-
:param organization_id: UUID of the Organziation the function belongs to.
429+
:param organization_id: UUID of the Organization the function belongs to.
430430
:param project_id: UUID of the Project the function belongs to.
431431
:return: :class:`ListFunctionsResponse <ListFunctionsResponse>`
432432
@@ -480,7 +480,7 @@ def list_functions_all(
480480
:param page_size: Number of functions per page.
481481
:param order_by: Order of the functions.
482482
:param name: Name of the function.
483-
:param organization_id: UUID of the Organziation the function belongs to.
483+
:param organization_id: UUID of the Organization the function belongs to.
484484
:param project_id: UUID of the Project the function belongs to.
485485
:return: :class:`List[Function] <List[Function]>`
486486
@@ -605,7 +605,7 @@ def create_function(
605605
:param region: Region to target. If none is passed will use default region from the config.
606606
:param name: Name of the function to create.
607607
:param environment_variables: Environment variables of the function.
608-
:param min_scale: Minumum number of instances to scale the function to.
608+
:param min_scale: Minimum number of instances to scale the function to.
609609
:param max_scale: Maximum number of instances to scale the function to.
610610
:param runtime: Runtime to use with the function.
611611
:param memory_limit: Memory limit of the function in MB.
@@ -685,7 +685,7 @@ def update_function(
685685
:param function_id: UUID of the function to update.
686686
:param region: Region to target. If none is passed will use default region from the config.
687687
:param environment_variables: Environment variables of the function to update.
688-
:param min_scale: Minumum number of instances to scale the function to.
688+
:param min_scale: Minimum number of instances to scale the function to.
689689
:param max_scale: Maximum number of instances to scale the function to.
690690
:param runtime: Runtime to use with the function.
691691
:param memory_limit: Memory limit of the function in MB.
@@ -1219,7 +1219,7 @@ def list_domains(
12191219
"""
12201220
List all domain name bindings.
12211221
List all domain name bindings in a specified region.
1222-
:param function_id: UUID of the function the domain is assoicated with.
1222+
:param function_id: UUID of the function the domain is associated with.
12231223
:param region: Region to target. If none is passed will use default region from the config.
12241224
:param page: Page number.
12251225
:param page_size: Number of domains per page.
@@ -1264,7 +1264,7 @@ def list_domains_all(
12641264
"""
12651265
List all domain name bindings.
12661266
List all domain name bindings in a specified region.
1267-
:param function_id: UUID of the function the domain is assoicated with.
1267+
:param function_id: UUID of the function the domain is associated with.
12681268
:param region: Region to target. If none is passed will use default region from the config.
12691269
:param page: Page number.
12701270
:param page_size: Number of domains per page.
@@ -1574,7 +1574,7 @@ def list_tokens(
15741574
:param page: Page number.
15751575
:param page_size: Number of tokens per page.
15761576
:param order_by: Sort order for the tokens.
1577-
:param function_id: UUID of the function the token is assoicated with.
1577+
:param function_id: UUID of the function the token is associated with.
15781578
:param namespace_id: UUID of the namespace the token is associated with.
15791579
:return: :class:`ListTokensResponse <ListTokensResponse>`
15801580
@@ -1619,7 +1619,7 @@ def list_tokens_all(
16191619
:param page: Page number.
16201620
:param page_size: Number of tokens per page.
16211621
:param order_by: Sort order for the tokens.
1622-
:param function_id: UUID of the function the token is assoicated with.
1622+
:param function_id: UUID of the function the token is associated with.
16231623
:param namespace_id: UUID of the namespace the token is associated with.
16241624
:return: :class:`List[Token] <List[Token]>`
16251625

0 commit comments

Comments
 (0)