update reading order kwarg docs (#17768)

Azure · Apr 2, 2021 · 6eb912d · 6eb912d
1 parent 72ea38b
commit 6eb912d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/...formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py b/...formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py
@@ -604,7 +604,7 @@ def begin_recognize_content(self, form, **kwargs):
         :keyword str reading_order: Reading order algorithm to sort the text lines returned. Supported
             reading orders include: basic (default), natural. Set 'basic' to sort lines left to right and top
             to bottom, although in some cases proximity is treated with higher priority. Set 'natural' to sort
-            lines by those which are more closely related to each other.
+            lines by using positional information to keep nearby lines together.
         :keyword content_type: Content-type of the body sent to the API. Content-type is
             auto-detected, but can be overridden by passing this keyword argument. For options,
             see :class:`~azure.ai.formrecognizer.FormContentType`.
@@ -695,7 +695,7 @@ def begin_recognize_content_from_url(self, form_url, **kwargs):
         :keyword str reading_order: Reading order algorithm to sort the text lines returned. Supported
             reading orders include: basic (default), natural. Set 'basic' to sort lines left to right and top
             to bottom, although in some cases proximity is treated with higher priority. Set 'natural' to sort
-            lines by those which are more closely related to each other.
+            lines by using positional information to keep nearby lines together.
         :keyword int polling_interval: Waiting time between two polls for LRO operations
             if no Retry-After header is present. Defaults to 5 seconds.
         :keyword str continuation_token: A continuation token to restart a poller from a saved state.

diff --git a/...izer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py b/...izer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py
@@ -616,7 +616,7 @@ async def begin_recognize_content(
         :keyword str reading_order: Reading order algorithm to sort the text lines returned. Supported
             reading orders include: basic (default), natural. Set 'basic' to sort lines left to right and top
             to bottom, although in some cases proximity is treated with higher priority. Set 'natural' to sort
-            lines by those which are more closely related to each other.
+            lines by using positional information to keep nearby lines together.
         :keyword content_type: Content-type of the body sent to the API. Content-type is
             auto-detected, but can be overridden by passing this keyword argument. For options,
             see :class:`~azure.ai.formrecognizer.FormContentType`.
@@ -708,7 +708,7 @@ async def begin_recognize_content_from_url(
         :keyword str reading_order: Reading order algorithm to sort the text lines returned. Supported
             reading orders include: basic (default), natural. Set 'basic' to sort lines left to right and top
             to bottom, although in some cases proximity is treated with higher priority. Set 'natural' to sort
-            lines by those which are more closely related to each other.
+            lines by using positional information to keep nearby lines together.
         :keyword int polling_interval: Waiting time between two polls for LRO operations
             if no Retry-After header is present. Defaults to 5 seconds.
         :keyword str continuation_token: A continuation token to restart a poller from a saved state.