-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Use float? for suggester fractional properties #3661
Conversation
This commit updates TermSuggester to use float? instead of decimal? for properties that take a float value. Add XML documentation to suggesters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So this looks 99% LGTM, soo many great xml docs additions.
I left some small nagging comments about 1%
of the new xmldocs additions.
public class CompletionField | ||
{ | ||
/// <summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hate the hate on adding xmldocs but not fan of these style of SandCastle'esque summaries that feel generated. I rather have none instead.
Further more to continue my nitpick for small summaries can we have a single line
//// <summary> The summary </summary>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for small summaries can we have a single line
I can do this. We'll also need to tweak our formatting configuration which always seems to format on multiple lines
src/Nest/Search/Suggesters/CompletionSuggester/CompletionField.cs
Outdated
Show resolved
Hide resolved
@@ -3,35 +3,61 @@ | |||
|
|||
namespace Nest | |||
{ | |||
/// <summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FuzzySugester
is a bad name now that I am rereading it maybe SuggesterFuzziness
?
Maybe link to https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-completion.html#fuzzy ?
The comment itself as it is now adds little IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++ to SuggesterFuzziness
; it better fits what it is.
I share some of the sentiment of GhostDoc/Sandcastle autogenerated XML comments. Do you think we should aim for consistency in applying <summary>
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the naming convention of other types, ISuggestFuzziness
might be more appropriate
I'm merging this in, to look to get an alpha release out |
This commit updates TermSuggester to use float? instead of decimal? for
properties that take a float value.
Add XML documentation to suggesters