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.

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

Jump to bottom

Arith divide options are mixed up #755

Open
ingomueller-net opened this issue Dec 15, 2024 · 0 comments · May be fixed by #761
Open

Arith divide options are mixed up #755

ingomueller-net opened this issue Dec 15, 2024 · 0 comments · May be fixed by #761

Comments

@ingomueller-net
Copy link
Contributor

The values for rounding and division by zero are mixed up in the doc:

on_division_by_zero ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']
rounding ['NAN', 'NULL', 'ERROR']

Will fix on Monday if nobody beats me to it.
ingomueller-net added a commit to ingomueller-net/substrait that referenced this issue Jan 6, 2025
@ingomueller-net
docs: fix and simplify logic that generates extension options docs
bf4b572 
This PR fixes the logic in `generate_function_docs.py` that generates
the docs for the options of functions. The previous version mixed up the
option names and the corresponding choices, leading to non-sensical docs
such as reported in substrait-io#755. This PR collects the option names and
corresponding choices jointly such that no mix-up can happen. I have
looked at the output that is changed by this script but only
superficially so: my impression is that (1) some options now come in a
different order (because the previous order was determined by the order
of keys in a `dict`, which is implementation-defined) and (2) the
remaining changes come from the intention of this PR, i.e., the
constitute fixes of previously non-sensical output. However, since I am
not intrically familiar with all extension functions, I am not 100%
sure.

Signed-off-by: Ingo Müller <[email protected]>
ingomueller-net added a commit to ingomueller-net/substrait that referenced this issue Jan 6, 2025
@ingomueller-net
docs: fix and simplify logic that generates extension options docs
1b3b118 
This PR fixes the logic in `generate_function_docs.py` that generates
the docs for the options of functions. The previous version mixed up the
option names and the corresponding choices, leading to non-sensical docs
such as reported in substrait-io#755. This PR collects the option names and
corresponding choices jointly such that no mix-up can happen. I have
looked at the output that is changed by this script but only
superficially so: my impression is that (1) some options now come in a
different order (because the previous order was determined by the order
of keys in a `dict`, which is implementation-defined) and (2) the
remaining changes come from the intention of this PR, i.e., the
constitute fixes of previously non-sensical output. However, since I am
not intrically familiar with all extension functions, I am not 100%
sure.

Signed-off-by: Ingo Müller <[email protected]>
@ingomueller-net ingomueller-net linked a pull request Jan 6, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: fix and simplify logic that generates extension options docs ingomueller-net/substrait
1 participant
@ingomueller-net