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

[DOCS] Document null/edge case handling for SQL functions #74193

Closed
10 tasks done
jrodewig opened this issue Jun 16, 2021 · 5 comments · Fixed by #74444
Closed
10 tasks done

[DOCS] Document null/edge case handling for SQL functions #74193

jrodewig opened this issue Jun 16, 2021 · 5 comments · Fixed by #74444
Assignees
Labels
:Analytics/SQL SQL querying >docs General docs changes Meta Team:Docs Meta label for docs team Team:QL (Deprecated) Meta label for query languages team

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Jun 16, 2021

We don't consistently document how our SQL functions handle null values and other edge cases (such as negative integers in string function args). We should update the docs for each function so users know what to expect.

Due to the number of functions, we'll likely need to break this up over several PRs. We should prioritize string functions so we can document the changes in #68379

CC @astefan

@jrodewig jrodewig added >docs General docs changes :Analytics/SQL SQL querying labels Jun 16, 2021
@jrodewig jrodewig self-assigned this Jun 16, 2021
@elasticmachine elasticmachine added Team:QL (Deprecated) Meta label for query languages team Team:Docs Meta label for docs team labels Jun 16, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-ql (Team:QL)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@matriv
Copy link
Contributor

matriv commented Jun 17, 2021

Similar to #68531. We should also check the way we document other edge case for args (e.g. a negative integer for string functions), to have a consistency across all functions, e.g. should it be marked with NOTE, or should it be with bullet points in the description of the args, or the description of the function.

@jrodewig
Copy link
Contributor Author

We should also check the way we document other edge case for args (e.g. a negative integer for string functions), to have a consistency across all functions, e.g. should it be marked with NOTE, or should it be with bullet points in the description of the args, or the description of the function.

Thanks @matriv. IMO it's more concise to provide this in the description of the arg. You avoid having to restate the arg name. I can work on making this consistent as part of my changes.

@matriv
Copy link
Contributor

matriv commented Jun 17, 2021

Yep, It's fine to have it there, I added this extra check for those cases, because back then I remember there were a few inconsistencies as well (apart from the null handling).

@jrodewig jrodewig changed the title [DOCS] Document null handling for SQL functions [DOCS] Document null/edge case handling for SQL functions Jun 17, 2021
jrodewig added a commit that referenced this issue Jun 17, 2021
#74201 documents `null` handling  to the arg descriptions of several string functions.

This PR moves pre-existing docs for `null` handling and similar edge case handling for string functions to arg descriptions for consistency.

Relates to #74193
jrodewig added a commit that referenced this issue Jun 17, 2021
#74201 documents `null` handling  to the arg descriptions of several string functions.

This PR moves pre-existing docs for `null` handling and similar edge case handling for string functions to arg descriptions for consistency.

Relates to #74193
jrodewig added a commit that referenced this issue Jun 17, 2021
#74201 documents `null` handling  to the arg descriptions of several string functions.

This PR moves pre-existing docs for `null` handling and similar edge case handling for string functions to arg descriptions for consistency.

Relates to #74193
jrodewig added a commit that referenced this issue Jun 17, 2021
#74201 documents `null` handling  to the arg descriptions of several string functions.

This PR moves pre-existing docs for `null` handling and similar edge case handling for string functions to arg descriptions for consistency.

Relates to #74193
@jrodewig jrodewig added the Meta label Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/SQL SQL querying >docs General docs changes Meta Team:Docs Meta label for docs team Team:QL (Deprecated) Meta label for query languages team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants