Skip to content
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

[ES|QL] Provide signature help #166089

Closed
dej611 opened this issue Sep 8, 2023 · 5 comments
Closed

[ES|QL] Provide signature help #166089

dej611 opened this issue Sep 8, 2023 · 5 comments
Labels
enhancement New value added to drive a business result Feature:ES|QL ES|QL related features in Kibana impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:ESQL ES|QL related features in Kibana

Comments

@dej611
Copy link
Contributor

dej611 commented Sep 8, 2023

Describe the feature:

A nice feature in Lens formula is the signature help which highlights the current definition of the used function, together with some doc/example, and positional information about arguments:

Screenshot 2023-09-08 at 16 33 04

I've made a quick PoC with ES|QL and the feature seems feasible:

image

Describe a specific use case for the feature:

It would be nice to implement this feature, and also leverage the signature information for more (i.e. validation or better autocomplete).

@dej611 dej611 added enhancement New value added to drive a business result Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:ES|QL ES|QL related features in Kibana labels Sep 8, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations (Team:Visualizations)

@stratoula stratoula added the impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. label Sep 8, 2023
@ninoslavmiskovic
Copy link
Contributor

@dej611 nice 👍 Where does it pull the content from ? We have been talking about unifying the documentation, so in this example does it pull the content from FROM documentation?

@dej611
Copy link
Contributor Author

dej611 commented Sep 8, 2023

Currently there are two source of documentation in the editor: one for the popover panel and another for the suggestion system (hovering an entry will show a right arrow that the user can click to show some short documentation as well).
Ideally both should be merged together into a single source and each medium should provide the portion of information required only.
For this feature we could hook into this system and reuse the same source.

@stratoula stratoula added Team:ESQL ES|QL related features in Kibana and removed Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Mar 27, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-esql (Team:ESQL)

@stratoula
Copy link
Contributor

Closing this in favor of #180528

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:ES|QL ES|QL related features in Kibana impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:ESQL ES|QL related features in Kibana
Projects
None yet
Development

No branches or pull requests

4 participants