Touch up of IElasticClient XMLDoc #598
Conversation
andersosthus
commented
Apr 18, 2014
andersosthus
commented
- Added API reference URL to ScrollAsync
- Changed API reference URL for Suggest and SuggestAsync to point to Suggest doc
- Added subsection to some API references
…ection to some API reference links
- Changed the _Fuzzy property in CompletionSuggestDescriptor to IFuzzySuggestDescriptor - Updated FuzzySuggestDescriptor to implement IFuzzySuggestDescriptor - Added FuzzinessSuggestDescriptor implementing IFuzzySuggestDescriptor - Added .Fuzziness method to CompletionSuggestDescriptor - Added unit tests in CompletionSuggestTests Issues: - Both the Fuzzy and Fuzziness methods returns a CompletionSuggestDescriptor<T>, so that means you can chain .Fuzzy and .Fuzziness. If you chain them, only the last one applied will be used. That might not be a problem, depending on what level of knowledge is expected from the developers using NEST.
|
Thanks for attempting to add fuziness support to the completion suggester @andersosthus ! Ping me when you feel its ready :) Some comments so far: Im Ok with I don't think: Should generate: As per the defaults section mentioned here: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-completion.html#fuzzy Sticking with the defaults: would suffice. Lastly can you sign the Elasticsearch CLA: http://www.elasticsearch.org/contributor-agreement/ So i can pull your bits in when they are done? 👍 |
Now generates fuzzy: {} when not supplying anything to the .Fuzziness
method, as per
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-completion.html#fuzzy
|
Hi @Mpdreamz, Thanks for the quick feedback :) First of all, do you want me to split this in two, one for the original Pull request, and one for the Fuzziness stuff ? I was a bit tired when I worked on this yesterday, so both PRs ended up in one :) My reasoning for the "fuzziness": "auto" was that it was the default. I didn't see the note at the bottom stating that "fuzzy": {} will use the default. I've changed .Fuzziness(); to now generate "fuzzy": {}, but won't that instead then default to using the "edit_distance" and "transpositions" defaults instead? I've signed the Elasticsearch CLA :) |
|
Or were you maybe thinking that .Fuzziness(); should generate |
.Fuzziness() now generates:
```
"fuzzy": {
"fuzziness": {}
}
```
Updated tests to reflect this. Also cleaned up the expected strings in
some cases (and my auto format did sneak in some spaces to tabs
conversions, but it looks like that's the desired format, so I hope you
don't mind).
Also tried to add a page to the documentation about Suggest.
|
@Mpdreamz Can you take a look at it now ? Think this should be about right |
|
Looks like my docs attempt made a small mess. Let me clean it up. |
|
Code, Tests & Docs in a single PR ! Awesome work @andersosthus. |
