From 0ddd9eabe5e450937a39dfbb57f37339322d3856 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Sat, 30 Apr 2022 01:03:02 -0700 Subject: [PATCH 1/2] fix missing brackets in docs --- .../formrecognizer/_form_recognizer_client.py | 24 +++++++++---------- .../aio/_form_recognizer_client_async.py | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py index 03b6c60ffcce..b28df240b207 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py +++ b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py @@ -111,7 +111,7 @@ def begin_recognize_receipts(self, receipt, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -187,7 +187,7 @@ def begin_recognize_receipts_from_url(self, receipt_url, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -260,7 +260,7 @@ def begin_recognize_business_cards(self, business_card, **kwargs): :paramtype content_type: str or ~azure.ai.formrecognizer.FormContentType :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -324,7 +324,7 @@ def begin_recognize_business_cards_from_url(self, business_card_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -375,7 +375,7 @@ def begin_recognize_identity_documents(self, identity_document, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -438,7 +438,7 @@ def begin_recognize_identity_documents_from_url( and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -489,7 +489,7 @@ def begin_recognize_invoices(self, invoice, **kwargs): :paramtype content_type: str or ~azure.ai.formrecognizer.FormContentType :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -552,7 +552,7 @@ def begin_recognize_invoices_from_url(self, invoice_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -766,8 +766,8 @@ def begin_recognize_custom_forms(self, model_id, form, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. - :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm] + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: .. admonition:: Example: @@ -850,8 +850,8 @@ def begin_recognize_custom_forms_from_url(self, model_id, form_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. - :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm] + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: """ diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py index ebee1175f85c..e302de11e604 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py +++ b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py @@ -786,7 +786,7 @@ async def begin_recognize_custom_forms( :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an AsyncLROPoller. Call `result()` on the poller object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. - :rtype: ~azure.core.polling.AsyncLROPoller[list[~azure.ai.formrecognizer.RecognizedForm] + :rtype: ~azure.core.polling.AsyncLROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: .. admonition:: Example: @@ -871,7 +871,7 @@ async def begin_recognize_custom_forms_from_url( :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an AsyncLROPoller. Call `result()` on the poller object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. - :rtype: ~azure.core.polling.AsyncLROPoller[list[~azure.ai.formrecognizer.RecognizedForm] + :rtype: ~azure.core.polling.AsyncLROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: """ From d2df5a7b041ef4cf6d0599921509895c26c5529c Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Tue, 3 May 2022 16:40:01 -0700 Subject: [PATCH 2/2] remove extra brackets --- .../formrecognizer/_form_recognizer_client.py | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py index b28df240b207..1bbd2cb25835 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py +++ b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py @@ -111,7 +111,7 @@ def begin_recognize_receipts(self, receipt, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -187,7 +187,7 @@ def begin_recognize_receipts_from_url(self, receipt_url, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -260,7 +260,7 @@ def begin_recognize_business_cards(self, business_card, **kwargs): :paramtype content_type: str or ~azure.ai.formrecognizer.FormContentType :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -324,7 +324,7 @@ def begin_recognize_business_cards_from_url(self, business_card_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -375,7 +375,7 @@ def begin_recognize_identity_documents(self, identity_document, **kwargs): and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -438,7 +438,7 @@ def begin_recognize_identity_documents_from_url( and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -489,7 +489,7 @@ def begin_recognize_invoices(self, invoice, **kwargs): :paramtype content_type: str or ~azure.ai.formrecognizer.FormContentType :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -552,7 +552,7 @@ def begin_recognize_invoices_from_url(self, invoice_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -766,7 +766,7 @@ def begin_recognize_custom_forms(self, model_id, form, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: @@ -850,7 +850,7 @@ def begin_recognize_custom_forms_from_url(self, model_id, form_url, **kwargs): `pages=["1-3", "5-6"]`. Separate each page number or range with a comma. :keyword str continuation_token: A continuation token to restart a poller from a saved state. :return: An instance of an LROPoller. Call `result()` on the poller - object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]]. + object to return a list[:class:`~azure.ai.formrecognizer.RecognizedForm`]. :rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]] :raises ~azure.core.exceptions.HttpResponseError: """