Skip to content

Commit 1878b74

Browse files
[Tables] pre-release script (Azure#18505)
* pre-release script * cleaning up * sphinx fixes
1 parent cf35ff4 commit 1878b74

File tree

8 files changed

+34
-31
lines changed

8 files changed

+34
-31
lines changed

sdk/tables/azure-data-tables/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release History
22

3-
## 12.0.0b7 (Unreleased)
3+
## 12.0.0b7 (2021-05-11)
44
**Breaking**
55
* The `account_url` parameter in the client constructors has been renamed to `endpoint`.
66
* The `TableEntity` object now acts exclusively like a dictionary, and no longer supports key access via attributes.

sdk/tables/azure-data-tables/azure/data/tables/_error.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,8 @@ class TableTransactionError(HttpResponseError):
157157
Defaults to 0 in the case where an index was not provided, or the error applies across operations.
158158
:ivar ~azure.data.tables.TableErrorCode error_code: The error code.
159159
:ivar str message: The error message.
160-
:ivar Mapping[str, Any] additional_info: Any additional data for the error.
160+
:ivar additional_info: Any additional data for the error.
161+
:vartype additional_info: Mapping[str, Any]
161162
"""
162163

163164
def __init__(self, **kwargs):

sdk/tables/azure-data-tables/azure/data/tables/_table_batch.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def create(
9292
"""Adds an insert operation to the current batch.
9393
9494
:param entity: The properties for the table entity.
95-
:type entity: TableEntity or dict[str,str]
95+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
9696
:return: None
9797
:rtype: None
9898
:raises ValueError:
@@ -216,9 +216,9 @@ def update(
216216
"""Adds an update operation to the current batch.
217217
218218
:param entity: The properties for the table entity.
219-
:type entity: TableEntity or dict[str,str]
219+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
220220
:param mode: Merge or Replace entity
221-
:type mode: ~azure.data.tables.UpdateMode
221+
:type mode: :class:`~azure.data.tables.UpdateMode`
222222
:keyword str etag: Etag of the entity
223223
:keyword match_condition: MatchCondition
224224
:paramtype match_condition: ~azure.core.MatchCondition
@@ -652,9 +652,9 @@ def upsert(
652652
"""Adds an upsert (update/merge) operation to the batch.
653653
654654
:param entity: The properties for the table entity.
655-
:type entity: TableEntity or dict[str,str]
655+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
656656
:param mode: Merge or Replace entity
657-
:type mode: ~azure.data.tables.UpdateMode
657+
:type mode: :class:`~azure.data.tables.UpdateMode`
658658
:raises ValueError:
659659
660660
.. admonition:: Example:

sdk/tables/azure-data-tables/azure/data/tables/_table_client.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ def delete_table(
252252
):
253253
# type: (...) -> None
254254
"""Deletes the table under the current account. No error will be raised
255-
if the table does not exist
255+
if the table does not exist
256256
257257
:return: None
258258
:rtype: None
@@ -288,7 +288,7 @@ def delete_entity(self, entity, **kwargs):
288288
def delete_entity(self, *args, **kwargs):
289289
# type: (Union[TableEntity, str], Any) -> None
290290
"""Deletes the specified entity in a table. No error will be raised if
291-
the entity or PartitionKey-RowKey pairing is not found.
291+
the entity or PartitionKey-RowKey pairing is not found.
292292
293293
:param partition_key: The partition key of the entity.
294294
:type partition_key: str
@@ -365,7 +365,7 @@ def create_entity(
365365
"""Insert entity in a table.
366366
367367
:param entity: The properties for the table entity.
368-
:type entity: ~azure.data.tables.TableEntity or Dict[str,str]
368+
:type entity: Dict[str,str] or :class:`~azure.data.tables.TableEntity`
369369
:return: Dictionary mapping operation metadata returned from the service
370370
:rtype: Dict[str,str]
371371
:raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -405,9 +405,9 @@ def update_entity(
405405
"""Update entity in a table.
406406
407407
:param entity: The properties for the table entity.
408-
:type entity: ~azure.data.tables.TableEntity or Dict[str,str]
408+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
409409
:param mode: Merge or Replace entity
410-
:type mode: ~azure.data.tables.UpdateMode
410+
:type mode: :class:`~azure.data.tables.UpdateMode`
411411
:keyword str etag: Etag of the entity
412412
:keyword match_condition: MatchCondition
413413
:paramtype match_condition: ~azure.core.MatchCondition
@@ -523,7 +523,8 @@ def query_entities(
523523
:keyword int results_per_page: Number of entities returned per service request.
524524
:keyword select: Specify desired properties of an entity to return.
525525
:paramtype select: str or List[str]
526-
:keyword Dict[str, Any] parameters: Dictionary for formatting query with additional, user defined parameters
526+
:keyword parameters: Dictionary for formatting query with additional, user defined parameters
527+
:paramtype parameters: Dict[str, Any]
527528
:return: ItemPaged[:class:`~azure.data.tables.TableEntity`]
528529
:rtype: ~azure.core.paging.ItemPaged
529530
:raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -612,9 +613,9 @@ def upsert_entity(
612613
"""Update/Merge or Insert entity into table.
613614
614615
:param entity: The properties for the table entity.
615-
:type entity: ~azure.data.tables.TableEntity or Dict[str,str]
616+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
616617
:param mode: Merge or Replace entity
617-
:type mode: ~azure.data.tables.UpdateMode
618+
:type mode: :class:`~azure.data.tables.UpdateMode`
618619
:return: Dictionary mapping operation metadata returned from the service
619620
:rtype: Dict[str,str]
620621
:raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -679,7 +680,7 @@ def submit_transaction(
679680
:type operations: Iterable[Tuple[str, EntityType]]
680681
:return: A list of mappings with response metadata for each operation in the transaction.
681682
:rtype: List[Mapping[str, Any]]
682-
:raises ~azure.data.tables.TableTransactionError:
683+
:raises: :class:`~azure.data.tables.TableTransactionError`
683684
684685
.. admonition:: Example:
685686

sdk/tables/azure-data-tables/azure/data/tables/_table_service_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ def list_tables(self, **kwargs):
289289
# type: (Any) -> ItemPaged[TableItem]
290290
"""Queries tables under the given account.
291291
292-
:keyword int results_per_page: Number of tables per page in return ItemPaged
292+
:keyword int results_per_page: Number of tables per page in returned ItemPaged
293293
:return: ItemPaged[:class:`~azure.data.tables.TableItem`]
294294
:rtype: ~azure.core.paging.ItemPaged
295295
:raises: :class:`~azure.core.exceptions.HttpResponseError`

sdk/tables/azure-data-tables/azure/data/tables/aio/_table_batch_async.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def create(
7171
"""Insert entity in a table.
7272
7373
:param entity: The properties for the table entity.
74-
:type entity: TableEntity or dict[str,str]
74+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
7575
:return: None
7676
:rtype: None
7777
:raises ValueError:
@@ -192,9 +192,9 @@ def update(
192192
"""Adds an update operation to the current batch.
193193
194194
:param entity: The properties for the table entity.
195-
:type entity: TableEntity or Dict[str,str]
195+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
196196
:param mode: Merge or Replace entity
197-
:type mode: ~azure.data.tables.UpdateMode
197+
:type mode: :class:`~azure.data.tables.UpdateMode`
198198
:keyword str etag: Etag of the entity
199199
:keyword match_condition: MatchCondition
200200
:paramtype match_condition: ~azure.core.MatchCondition
@@ -616,9 +616,9 @@ def upsert(
616616
"""Update/Merge or Insert entity into table.
617617
618618
:param entity: The properties for the table entity.
619-
:type entity: TableEntity or dict[str,str]
619+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
620620
:param mode: Merge or Replace entity
621-
:type mode: ~azure.data.tables.UpdateMode
621+
:type mode: :class:`~azure.data.tables.UpdateMode`
622622
:return: None
623623
:rtype: None
624624
:raises ValueError:

sdk/tables/azure-data-tables/azure/data/tables/aio/_table_client_async.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ async def create_table(self, **kwargs) -> None:
244244
@distributed_trace_async
245245
async def delete_table(self, **kwargs) -> None:
246246
"""Deletes the table under the current account. No error will be raised if
247-
the given table name is not found.
247+
the given table name is not found.
248248
249249
:return: None
250250
:rtype: None
@@ -277,7 +277,7 @@ async def delete_entity(self, entity: Union[TableEntity, Mapping[str, Any]], **k
277277
@distributed_trace_async
278278
async def delete_entity(self, *args: Union[TableEntity, str], **kwargs: Any) -> None:
279279
"""Deletes the specified entity in a table. No error will be raised if
280-
the entity or PartitionKey-RowKey pairing is not found.
280+
the entity or PartitionKey-RowKey pairing is not found.
281281
282282
:param partition_key: The partition key of the entity.
283283
:type partition_key: str
@@ -353,7 +353,7 @@ async def create_entity(
353353
"""Insert entity in a table.
354354
355355
:param entity: The properties for the table entity.
356-
:type entity: ~azure.data.tables.TableEntity or Dict[str,str]
356+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
357357
:return: Dictionary mapping operation metadata returned from the service
358358
:rtype: Dict[str,str]
359359
:raises: :class:`~azure.core.exceptions.ResourceExistsError` If the entity already exists
@@ -393,9 +393,9 @@ async def update_entity(
393393
"""Update entity in a table.
394394
395395
:param entity: The properties for the table entity.
396-
:type entity: dict[str, str]
396+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
397397
:param mode: Merge or Replace entity
398-
:type mode: ~azure.data.tables.UpdateMode
398+
:type mode: :class:`~azure.data.tables.UpdateMode`
399399
:keyword str etag: Etag of the entity
400400
:keyword match_condition: MatchCondition
401401
:paramtype match_condition: ~azure.core.MatchCondition
@@ -507,7 +507,8 @@ def query_entities(
507507
:keyword int results_per_page: Number of entities returned per service request.
508508
:keyword select: Specify desired properties of an entity to return.
509509
:paramtype select: str or List[str]
510-
:keyword Dict[str, Any] parameters: Dictionary for formatting query with additional, user defined parameters
510+
:keyword parameters: Dictionary for formatting query with additional, user defined parameters
511+
:paramtype parameters: Dict[str, Any]
511512
:return: AsyncItemPaged[:class:`~azure.data.tables.TableEntity`]
512513
:rtype: ~azure.core.async_paging.AsyncItemPaged
513514
:raises: :class:`~azure.core.exceptions.HttpResponseError`
@@ -594,9 +595,9 @@ async def upsert_entity(
594595
"""Update/Merge or Insert entity into table.
595596
596597
:param entity: The properties for the table entity.
597-
:type entity: TableEntity or dict[str,str]
598+
:type entity: :class:`~azure.data.tables.TableEntity` or Dict[str,str]
598599
:param mode: Merge or Replace entity
599-
:type mode: ~azure.data.tables.UpdateMode
600+
:type mode: :class:`~azure.data.tables.UpdateMode`
600601
:return: Dictionary mapping operation metadata returned from the service
601602
:rtype: Dict[str,str]
602603
:raises: :class:`~azure.core.exceptions.HttpResponseError`

sdk/tables/azure-data-tables/azure/data/tables/aio/_table_service_client_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ async def delete_table(self, table_name: str, **kwargs) -> None:
246246
def list_tables(self, **kwargs) -> AsyncItemPaged[TableItem]:
247247
"""Queries tables under the given account.
248248
249-
:keyword int results_per_page: Number of tables per page in return ItemPaged
249+
:keyword int results_per_page: Number of tables per page in returned ItemPaged
250250
:return: AsyncItemPaged[:class:`~azure.data.tables.TableItem`]
251251
:rtype: ~azure.core.async_paging.AsyncItemPaged
252252
:raises: :class:`~azure.core.exceptions.HttpResponseError`

0 commit comments

Comments
 (0)