Skip to content

fix doc for highlight_fields #19916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xiangyan99 merged 1 commit into from
Jul 22, 2021
Merged

fix doc for highlight_fields #19916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sdk/search/azure-search-documents/azure/search/documents/_search_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down