You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/10/22 22:55:17 UTC

[PR] Minor: Add documentation for `cot` [datafusion]

alamb opened a new pull request, #13069:
URL: https://github.com/apache/datafusion/pull/13069

   ## 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 https://github.com/apache/datafusion/issues/12872
   
   ```shell
   (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 https://github.com/apache/datafusion/pull/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!
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api change` label.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add documentation for `cot` [datafusion]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #13069:
URL: https://github.com/apache/datafusion/pull/13069#issuecomment-2435547164

   Thank you @jonahgao for the review


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add documentation for `cot` [datafusion]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #13069:
URL: https://github.com/apache/datafusion/pull/13069#issuecomment-2435552463

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


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org


Re: [PR] Minor: Add documentation for `cot` [datafusion]

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #13069:
URL: https://github.com/apache/datafusion/pull/13069


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org