From 2e60b97181b0ca66f6a796e981be3473c9f8b638 Mon Sep 17 00:00:00 2001 From: Xiang Yan Date: Thu, 22 Jul 2021 11:52:11 -0700 Subject: [PATCH] fix doc for highlight_fields (#19916) --- .../azure/search/documents/_search_client.py | 4 ++-- .../azure/search/documents/aio/_search_client_async.py | 4 ++-- 2 files changed, 4 insertions(+), 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 index 8455626832c7..e50c56c60c4a 100644 --- 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 . :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 index 620c82b17fb3..f7ed87bcd127 100644 --- 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 . :keyword str highlight_pre_tag: A string tag that is prepended to hit highlights. Must be set with