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

Minor: Add documentation for cot #13069

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Minor: Add documentation for cot #13069

merged 3 commits into from
Oct 24, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Oct 22, 2024

Which issue does this PR close?

Part of #12740

Rationale for this change

I noticed that the cot function does not have documentation by running the script in #12872

(venv) andrewlamb@Andrews-MacBook-Pro-2:~/Software/datafusion$ ./dev/update_function_docs.sh
...
Running CLI and inserting scalar function docs table
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.25s
     Running `target/debug/print_functions_docs scalar`
INFO: The following functions do not have documentation:
  - map_extract
  - map
  - cot
  - map_keys
  - map_values

Note that @ jonathanc-n is working on the map functions in #13047

In fact it appears to be completely undocumented in the old docs too: https://datafusion.apache.org/user-guide/sql/scalar_functions.html so this is a win for the automated script

What changes are included in this PR?

Add docs to cot

Are these changes tested?

Yes by CI

Are there any user-facing changes?

More docs!

@github-actions github-actions bot added documentation Improvements or additions to documentation functions labels Oct 22, 2024
Copy link
Member

@jonahgao jonahgao left a comment

Choose a reason for hiding this comment

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

LGTM👍

@alamb
Copy link
Contributor Author

alamb commented Oct 24, 2024

Thank you @jonahgao for the review

@alamb
Copy link
Contributor Author

alamb commented Oct 24, 2024

I reran the doc generator locally to make sure there are no logical conflicts and things looked good

@alamb alamb merged commit 307c1ea into apache:main Oct 24, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants