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
| public class CompletionField | ||
| { | ||
| /// <summary> |
There was a problem hiding this comment.
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.
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.
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.
++ 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.
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