Skip to content

Minor: Add documentation for cot - #13069

Merged
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/cot_docs
Oct 24, 2024
Merged

Minor: Add documentation for cot#13069
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/cot_docs

Conversation

@alamb

Copy link
Copy Markdown
Contributor

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 functiondocs 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-actionsgithub-actionsBot added documentation Improvements or additions to documentation functions Changes to functions implementation labels Oct 22, 2024

@jonahgaojonahgao left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM👍

@alamb

Copy link
Copy Markdown
ContributorAuthor

Thank you @jonahgao for the review

@alamb

Copy link
Copy Markdown
ContributorAuthor

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:mainOct 24, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationfunctionsChanges to functions implementation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alamb@jonahgao