Skip to content
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.

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

added highlight_fields property #241

Merged
merged 2 commits into from
Sep 2, 2024
Merged

Conversation

agauch
Copy link
Contributor

@agauch agauch commented Aug 29, 2024

I added the property "highlight_fields" in the search parameters.

@runeanielsen runeanielsen self-assigned this Aug 30, 2024
@runeanielsen
Copy link
Member

runeanielsen commented Aug 31, 2024

Hi @agauch,

Thank you for the contribution, can I get you to add a bit more documentation to the docstring.

Example insert the docs from the Typesense API documentation https://typesense.org/docs/27.0/api/search.html#results-parameters:

"
Comma separated list of fields which should be highlighted fully without snippeting.

Default: all fields will be snippeted.

Set to none to disable highlighting fully.
"

// Rune

@runeanielsen runeanielsen self-requested a review August 31, 2024 05:17
Comment on lines 272 to 274
/// <summary>
/// List of fields which should be highlighted with snippetting.
/// </summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add more documentation to the documentation, you could for example use the documentation from the API spec. https://typesense.org/docs/27.0/api/search.html#results-parameters

@agauch
Copy link
Contributor Author

agauch commented Sep 2, 2024

Hello @runeanielsen,
The docstring is completed as requested.

@runeanielsen
Copy link
Member

@agauch looks great, thank you very much for making the change. :)

// Rune

@runeanielsen runeanielsen merged commit 701fe9c into DAXGRID:master Sep 2, 2024
2 checks passed
@runeanielsen
Copy link
Member

Hi @agauch, I've made a new release with tag 7.16.0 with your changes.

@agauch
Copy link
Contributor Author

agauch commented Sep 2, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants