Skip to content

Conversation

@stevejgordon
Copy link
Contributor

This introduces a new property for the word delimiter graph token filter to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563

Contributes to #5096

@Mpdreamz - I included more verbose XML comments for this to make usage via the Fluent API easier. I noticed that currently all descriptor methods use /// <inheritdoc /> which seems to have no effect. Is there a reason for the existing comments? If this format is reasonable, I'd propose to spend some time updating other comments for the WordDelimiterGraphTokenFilterDescriptor and as I come to them, other descriptors.

This introduces a new property for the word delimiter graph token filter
to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563
@Mpdreamz
Copy link
Member

Mpdreamz commented Nov 26, 2020

We used to have a custom F# build task that patched our xml documentation files so that <inheritdoc/> would be filled in based on the xml docs on the interface.

When pushing the transport bits out to https://github.com/elastic/elastic-transport-net, I re-enabled compilation failing on missing xmldocs.

It also relies on <inheritdoc> but this time through

https://github.com/saucecontrol/InheritDoc

ALthough more explicitly though <inheritdoc cref="IInterface.Property" />" also on descriptors.

(small lie in that saucecontrol/InheritDoc is not hooked up yet, but I intend too! :))

More xmldocs is always good!

Long term property descriptions will be picked up from the specification:

https://github.com/elastic/elastic-client-generator/blob/master/specification/specs/analysis/token_filters/word_delimiter_graph/WordDelimiterGraphTokenFilter.ts#L13

In which case I think generating them once on the interface and using <inheritdoc> for implementations is still a great way to keep to keep the generated LOC down.

@stevejgordon stevejgordon merged commit c9848a1 into 7.10 Nov 26, 2020
@stevejgordon stevejgordon deleted the feature/ignore-keywords-flag branch November 26, 2020 12:38
github-actions bot pushed a commit that referenced this pull request Nov 26, 2020
This introduces a new property for the word delimiter graph token filter
to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563
github-actions bot pushed a commit that referenced this pull request Nov 26, 2020
This introduces a new property for the word delimiter graph token filter
to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563
stevejgordon added a commit that referenced this pull request Nov 30, 2020
This introduces a new property for the word delimiter graph token filter
to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
stevejgordon added a commit that referenced this pull request Nov 30, 2020
This introduces a new property for the word delimiter graph token filter
to configure ignoring of keywords.

It relates to this change elastic/elasticsearch#59563

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
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.

3 participants