Skip to content

Commit 2e60b97

Browse files
authored
fix doc for highlight_fields (Azure#19916)
1 parent 28837f5 commit 2e60b97

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

sdk/search/azure-search-documents/azure/search/documents/_search_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,8 @@ def search(self, search_text, **kwargs):
165165
expression contains a field name, optionally followed by a comma-separated list of name:value
166166
pairs.
167167
:keyword str filter: The OData $filter expression to apply to the search query.
168-
:keyword list[str] highlight_fields: The list of field names to use for hit highlights. Only searchable
169-
fields can be used for hit highlighting.
168+
:keyword str highlight_fields: The comma-separated list of field names to use for hit highlights.
169+
Only searchable fields can be used for hit highlighting.
170170
:keyword str highlight_post_tag: A string tag that is appended to hit highlights. Must be set with
171171
highlightPreTag. Default is </em>.
172172
:keyword str highlight_pre_tag: A string tag that is prepended to hit highlights. Must be set with

sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ async def search(self, search_text, **kwargs):
141141
expression contains a field name, optionally followed by a comma-separated list of name:value
142142
pairs.
143143
:keyword str filter: The OData $filter expression to apply to the search query.
144-
:keyword list[str] highlight_fields: The list of field names to use for hit highlights. Only searchable
145-
fields can be used for hit highlighting.
144+
:keyword str highlight_fields: The comma-separated list of field names to use for hit highlights.
145+
Only searchable fields can be used for hit highlighting.
146146
:keyword str highlight_post_tag: A string tag that is appended to hit highlights. Must be set with
147147
highlightPreTag. Default is </em>.
148148
:keyword str highlight_pre_tag: A string tag that is prepended to hit highlights. Must be set with

0 commit comments

Comments
 (0)