Skip to content

Commit

Permalink
Updated doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
@allenkim0129
allenkim0129 committed Nov 18, 2024
1 parent 9549143 commit c6e2f1b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand Down Expand Up @@ -565,7 +565,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand All @@ -588,7 +588,7 @@ def query_items_change_feed(
) -> AsyncItemPaged[Dict[str, Any]]:
"""Get a sorted list of items that were changed, in the order in which they were modified.
:keyword str continuation: The continuation token retrieved from previous response.
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
:type continuation: str
:keyword int max_item_count: Max number of items to be returned in the enumeration operation.
:paramtype max_item_count: Optional[int]
Expand Down Expand Up @@ -629,7 +629,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand All @@ -649,7 +649,7 @@ def query_items_change_feed( # pylint: disable=unused-argument

"""Get a sorted list of items that were changed, in the order in which they were modified.
:keyword str continuation: The continuation token retrieved from previous response.
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
:keyword Dict[str, Any] feed_range: The feed range that is used to define the scope.
:keyword partition_key: The partition key that is used to define the scope
(logical partition or a subset of a container)
Expand All @@ -665,7 +665,7 @@ def query_items_change_feed( # pylint: disable=unused-argument
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand Down
12 changes: 6 additions & 6 deletions sdk/cosmos/azure-cosmos/azure/cosmos/container.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand Down Expand Up @@ -387,7 +387,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand All @@ -410,7 +410,7 @@ def query_items_change_feed(
) -> ItemPaged[Dict[str, Any]]:
"""Get a sorted list of items that were changed, in the order in which they were modified.
:keyword str continuation: The continuation token retrieved from previous response.
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
:paramtype continuation: str
:keyword int max_item_count: Max number of items to be returned in the enumeration operation.
:paramtype max_item_count: Optional[int]
Expand Down Expand Up @@ -450,7 +450,7 @@ def query_items_change_feed(
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:paramtype priority: Optional[Literal["High", "Low"]]
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand All @@ -471,7 +471,7 @@ def query_items_change_feed(

"""Get a sorted list of items that were changed, in the order in which they were modified.
:keyword str continuation: The continuation token retrieved from previous response.
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
:keyword Dict[str, Any] feed_range: The feed range that is used to define the scope.
:keyword partition_key: The partition key that is used to define the scope
(logical partition or a subset of a container)
Expand All @@ -486,7 +486,7 @@ def query_items_change_feed(
:keyword Literal["High", "Low"] priority: Priority based execution allows users to set a priority for each
request. Once the user has reached their provisioned throughput, low priority requests are throttled
before high priority requests start getting throttled. Feature must first be enabled at the account level.
:keyword mode: The change feed mode enum to use when processing change feed items.
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
or 'continuation' token.
Expand Down

0 comments on commit c6e2f1b

Please sign in to comment.