opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
67 stars 453 forks source link

Unintelligible text in search-plugins/sql/ppl/functions/ [DOC] #7689

Open smacrakis opened 1 month ago

smacrakis commented 1 month ago

What do you want to do?

Tell us about your request. Provide a summary of the request.

What does "Example 3: Filter and sort be casted parsed field" mean? The example seems to show filtering on a parsed field and then sorting on that same field. Maybe the title should be "Example 3: Filter and sort a parsed field".

The examples all work with a sample data set "accounts". But that doesn't seem to be in the standard distribution. Where can I find it so that I can try out the examples?

Also, I can't find the documentation for the function ''num'' in "sort num(streetNumber)". I'l guess that it converts a string to a number (very handy) -- but where is it documented? I couldn't get it to work in OpenSearch, either.

*Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

2.15

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

hdhalter commented 1 month ago

Thanks, @smacrakis. Can you please add some links to the applicable content?

smacrakis commented 1 month ago

Done. Sorry about that. I wonder if we could get the "create an issue" link to pre-populate the title with the URL for lazy/careless people like me.

hdhalter commented 1 month ago

Done. Sorry about that. I wonder if we could get the "create an issue" link to pre-populate the title with the URL for lazy/careless people like me.

It's a good idea, but we prefer that people click "Edit this page" and make the change to the page directly. :) Even if you create a PR without all the answers, we can find an SME that can review and supplement the added content.

smacrakis commented 1 month ago

So you're saying that I should write something like:

You can find the ''accounts'' test data at XXX. (where I don't know what XXX is)

The "sort" command supports the syntax sort num(field) to interpret the field as numerical. <<< is this true?? because num(...) is not supported elsewhere

hdhalter commented 1 month ago

So you're saying that I should write something like:

You can find the ''accounts'' test data at XXX. (where I don't know what XXX is)

The "sort" command supports the syntax sort num(field) to interpret the field as numerical. <<< is this true?? because num(...) is not supported elsewhere

Yes! Collaborating on a pull request is a good way to fast-track a fix.