Skip to content

Commit 75cbba7

Browse files
mbhaskarCopilot
andcommitted
Fix pylint line-too-long (C0301) in GSI docstrings
Wrap :keyword docstring lines to stay within 120 char limit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 89d1d9c commit 75cbba7

2 files changed

Lines changed: 36 additions & 18 deletions

File tree

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_database.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,8 @@ async def create_container(
218218
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
219219
Used to denote the default language to be used for all full text indexes, or to individually
220220
assign a language to each full text index path.
221-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
221+
:keyword global_secondary_index_definition: **provisional** The global secondary index
222+
definition for the container.
222223
Used to create a GSI container derived from a source container via a SQL projection query.
223224
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
224225
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -303,7 +304,8 @@ async def create_container( # pylint: disable=too-many-statements
303304
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
304305
Used to denote the default language to be used for all full text indexes, or to individually
305306
assign a language to each full text index path.
306-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
307+
:keyword global_secondary_index_definition: **provisional** The global secondary index
308+
definition for the container.
307309
Used to create a GSI container derived from a source container via a SQL projection query.
308310
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
309311
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -374,7 +376,8 @@ async def create_container( # pylint:disable=docstring-should-be-keyword, too-ma
374376
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
375377
Used to denote the default language to be used for all full text indexes, or to individually
376378
assign a language to each full text index path.
377-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
379+
:keyword global_secondary_index_definition: **provisional** The global secondary index
380+
definition for the container.
378381
Used to create a GSI container derived from a source container via a SQL projection query.
379382
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
380383
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -539,7 +542,8 @@ async def create_container_if_not_exists(
539542
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
540543
Used to denote the default language to be used for all full text indexes, or to individually
541544
assign a language to each full text index path.
542-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
545+
:keyword global_secondary_index_definition: **provisional** The global secondary index
546+
definition for the container.
543547
Used to create a GSI container derived from a source container via a SQL projection query.
544548
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
545549
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -608,7 +612,8 @@ async def create_container_if_not_exists(
608612
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
609613
Used to denote the default language to be used for all full text indexes, or to individually
610614
assign a language to each full text index path.
611-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
615+
:keyword global_secondary_index_definition: **provisional** The global secondary index
616+
definition for the container.
612617
Used to create a GSI container derived from a source container via a SQL projection query.
613618
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
614619
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -663,7 +668,8 @@ async def create_container_if_not_exists( # pylint:disable=docstring-should-be-k
663668
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
664669
Used to denote the default language to be used for all full text indexes, or to individually
665670
assign a language to each full text index path.
666-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
671+
:keyword global_secondary_index_definition: **provisional** The global secondary index
672+
definition for the container.
667673
Used to create a GSI container derived from a source container via a SQL projection query.
668674
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
669675
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -903,7 +909,8 @@ async def replace_container(
903909
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
904910
Used to denote the default language to be used for all full text indexes, or to individually
905911
assign a language to each full text index path.
906-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
912+
:keyword global_secondary_index_definition: **provisional** The global secondary index
913+
definition for the container.
907914
Used to create a GSI container derived from a source container via a SQL projection query.
908915
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
909916
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -968,7 +975,8 @@ async def replace_container( # pylint:disable=docstring-missing-param
968975
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
969976
Used to denote the default language to be used for all full text indexes, or to individually
970977
assign a language to each full text index path.
971-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
978+
:keyword global_secondary_index_definition: **provisional** The global secondary index
979+
definition for the container.
972980
Used to create a GSI container derived from a source container via a SQL projection query.
973981
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
974982
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -1023,7 +1031,8 @@ async def replace_container( # pylint:disable=docstring-should-be-keyword
10231031
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
10241032
Used to denote the default language to be used for all full text indexes, or to individually
10251033
assign a language to each full text index path.
1026-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
1034+
:keyword global_secondary_index_definition: **provisional** The global secondary index
1035+
definition for the container.
10271036
Used to create a GSI container derived from a source container via a SQL projection query.
10281037
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
10291038
:keyword bool return_properties: Specifies whether to return either a ContainerProxy

sdk/cosmos/azure-cosmos/azure/cosmos/database.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,8 @@ def create_container( # pylint:disable=docstring-missing-param
213213
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
214214
Used to denote the default language to be used for all full text indexes, or to individually
215215
assign a language to each full text index path.
216-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
216+
:keyword global_secondary_index_definition: **provisional** The global secondary index
217+
definition for the container.
217218
Used to create a GSI container derived from a source container via a SQL projection query.
218219
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
219220
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -294,7 +295,8 @@ def create_container( # pylint:disable=docstring-missing-param
294295
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
295296
Used to denote the default language to be used for all full text indexes, or to individually
296297
assign a language to each full text index path.
297-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
298+
:keyword global_secondary_index_definition: **provisional** The global secondary index
299+
definition for the container.
298300
Used to create a GSI container derived from a source container via a SQL projection query.
299301
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
300302
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -360,7 +362,8 @@ def create_container( # pylint:disable=docstring-missing-param, too-many-statem
360362
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
361363
Used to denote the default language to be used for all full text indexes, or to individually
362364
assign a language to each full text index path.
363-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
365+
:keyword global_secondary_index_definition: **provisional** The global secondary index
366+
definition for the container.
364367
Used to create a GSI container derived from a source container via a SQL projection query.
365368
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
366369
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -527,7 +530,8 @@ def create_container_if_not_exists( # pylint:disable=docstring-missing-param
527530
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
528531
Used to denote the default language to be used for all full text indexes, or to individually
529532
assign a language to each full text index path.
530-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
533+
:keyword global_secondary_index_definition: **provisional** The global secondary index
534+
definition for the container.
531535
Used to create a GSI container derived from a source container via a SQL projection query.
532536
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
533537
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -594,7 +598,8 @@ def create_container_if_not_exists( # pylint:disable=docstring-missing-param
594598
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
595599
Used to denote the default language to be used for all full text indexes, or to individually
596600
assign a language to each full text index path.
597-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
601+
:keyword global_secondary_index_definition: **provisional** The global secondary index
602+
definition for the container.
598603
Used to create a GSI container derived from a source container via a SQL projection query.
599604
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
600605
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -646,7 +651,8 @@ def create_container_if_not_exists( # pylint:disable=docstring-missing-param, d
646651
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
647652
Used to denote the default language to be used for all full text indexes, or to individually
648653
assign a language to each full text index path.
649-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
654+
:keyword global_secondary_index_definition: **provisional** The global secondary index
655+
definition for the container.
650656
Used to create a GSI container derived from a source container via a SQL projection query.
651657
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
652658
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -953,7 +959,8 @@ def replace_container( # pylint:disable=docstring-missing-param
953959
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
954960
Used to denote the default language to be used for all full text indexes, or to individually
955961
assign a language to each full text index path.
956-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
962+
:keyword global_secondary_index_definition: **provisional** The global secondary index
963+
definition for the container.
957964
Used to create a GSI container derived from a source container via a SQL projection query.
958965
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
959966
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -1017,7 +1024,8 @@ def replace_container( # pylint:disable=docstring-missing-param
10171024
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
10181025
Used to denote the default language to be used for all full text indexes, or to individually
10191026
assign a language to each full text index path.
1020-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
1027+
:keyword global_secondary_index_definition: **provisional** The global secondary index
1028+
definition for the container.
10211029
Used to create a GSI container derived from a source container via a SQL projection query.
10221030
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
10231031
:keyword bool return_properties: Specifies whether to return either a ContainerProxy
@@ -1069,7 +1077,8 @@ def replace_container( # pylint:disable=docstring-missing-param, docstring-shou
10691077
:keyword dict[str, Any] full_text_policy: **provisional** The full text policy for the container.
10701078
Used to denote the default language to be used for all full text indexes, or to individually
10711079
assign a language to each full text index path.
1072-
:keyword global_secondary_index_definition: **provisional** The global secondary index definition for the container.
1080+
:keyword global_secondary_index_definition: **provisional** The global secondary index
1081+
definition for the container.
10731082
Used to create a GSI container derived from a source container via a SQL projection query.
10741083
:paramtype global_secondary_index_definition: ~azure.cosmos.GlobalSecondaryIndexDefinition or dict[str, Any]
10751084
:keyword bool return_properties: Specifies whether to return either a ContainerProxy

0 commit comments

Comments
 (0)