Skip to content

ESQL - generate docs for snapshot functions #113080

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 19, 2024
Merged

ESQL - generate docs for snapshot functions #113080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
955b256
Add snapshot functions to doc generation
carlosdelest Sep 18, 2024
47ab4e1
Make Categorize snapshot function compliant for doc generation
carlosdelest Sep 18, 2024
a3f4067
Add Categorize function docs
carlosdelest Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/reference/esql/functions/description/categorize.asciidoc
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions docs/reference/esql/functions/kibana/definition/categorize.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions docs/reference/esql/functions/kibana/docs/categorize.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions docs/reference/esql/functions/layout/categorize.asciidoc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this to work and be in the docs, it also has to be linked in one of the root asciidocs.
In this case, it would be this one: https://github.com/elastic/elasticsearch/blob/a21242054b87e456f6e301dfa017e612b83ebbd6/docs/reference/esql/functions/grouping-functions.asciidoc

That said, do we want to include snapshot-only functions in the global docs?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making the files without plugging them in shouldn't hurt anything if that's what we want to do. I think we're ok doing that. I am. We should just make sure folks know having the generated asciidoc doesn't mean it's there - you have to look for the inclusion. For qstr I believe the plan is to include it only in snapshot docs. INLINESTATS works that way:

ifeval::["{release-state}"=="unreleased"]
* experimental:[] <<esql-inlinestats-by>>
endif::[]

...

ifeval::["{release-state}"=="unreleased"]
include::processing-commands/inlinestats.asciidoc[]
endif::[]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making the files without plugging them in shouldn't hurt anything

Indeed, but I feel like adding those without actually including them leaves things half-done. And it's harder later to know which ones are missing.

Btw, didn't know we had those conditionals! I'd include it with them, and that's all. About making sure it's done, it feels a bit more complex, and I can't think of a good way that doesn't pass through autogenerating those files too 👀 (Which feels like the eventual solution...)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct - for now, we're not including the docs as these functions are not production ready yet.

Including functions docs should be ok if they are not linked to the global docs - they can exist but not be connected until we do so for production readiness.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions docs/reference/esql/functions/parameters/categorize.asciidoc
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/reference/esql/functions/signature/categorize.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/reference/esql/functions/types/categorize.asciidoc
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ...l/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public class Categorize extends GroupingFunction implements Validatable {

private final Expression field;

@FunctionInfo(returnType = { "integer" }, description = "Categorizes text messages")
@FunctionInfo(returnType = { "integer" }, description = "Categorizes text messages.")
public Categorize(
Source source,
@Param(name = "field", type = { "text", "keyword" }, description = "Expression to categorize") Expression field
Expand Down
2 changes: 1 addition & 1 deletion .../test/java/org/elasticsearch/xpack/esql/expression/function/AbstractFunctionTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,7 @@ protected static String functionName() {
}

private static FunctionDefinition definition(String name) {
EsqlFunctionRegistry registry = new EsqlFunctionRegistry();
EsqlFunctionRegistry registry = new EsqlFunctionRegistry().snapshotRegistry();
if (registry.functionExists(name)) {
return registry.resolveFunction(name);
}
Expand Down
Loading