fix doc for highlight_fields (#19916)

Azure · Jul 22, 2021 · 2e60b97 · 2e60b97
1 parent 28837f5
commit 2e60b97
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/sdk/search/azure-search-documents/azure/search/documents/_search_client.py b/sdk/search/azure-search-documents/azure/search/documents/_search_client.py
@@ -165,8 +165,8 @@ def search(self, search_text, **kwargs):
          expression contains a field name, optionally followed by a comma-separated list of name:value
          pairs.
         :keyword str filter: The OData $filter expression to apply to the search query.
-        :keyword list[str] highlight_fields: The list of field names to use for hit highlights. Only searchable
-         fields can be used for hit highlighting.
+        :keyword str highlight_fields: The comma-separated list of field names to use for hit highlights.
+         Only searchable fields can be used for hit highlighting.
         :keyword str highlight_post_tag: A string tag that is appended to hit highlights. Must be set with
          highlightPreTag. Default is </em>.
         :keyword str highlight_pre_tag: A string tag that is prepended to hit highlights. Must be set with

diff --git a/sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py b/sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py
@@ -141,8 +141,8 @@ async def search(self, search_text, **kwargs):
          expression contains a field name, optionally followed by a comma-separated list of name:value
          pairs.
         :keyword str filter: The OData $filter expression to apply to the search query.
-        :keyword list[str] highlight_fields: The list of field names to use for hit highlights. Only searchable
-         fields can be used for hit highlighting.
+        :keyword str highlight_fields: The comma-separated list of field names to use for hit highlights.
+         Only searchable fields can be used for hit highlighting.
         :keyword str highlight_post_tag: A string tag that is appended to hit highlights. Must be set with
          highlightPreTag. Default is </em>.
         :keyword str highlight_pre_tag: A string tag that is prepended to hit highlights. Must be set with