Skip to content

Update Scalar_functions.md #17018

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update Scalar_functions.md #17018

wants to merge 2 commits into from

Conversation

Adez017
Copy link
Contributor

@Adez017 Adez017 commented Aug 2, 2025

Which issue does this PR close?

Rationale for this change

while Browsing through the documentation i find the example for the scalar functions are missing

What changes are included in this PR?

Added examples for documentation

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 2, 2025
@Adez017
Copy link
Contributor Author

Adez017 commented Aug 2, 2025

hi @alamb , i coudnt find any rust file for this function . directly added the examples to the markdown . need a little help , while firing

./dev/update_function_docs.sh

my system doesnt updates the files . please can you do that

@alamb
Copy link
Contributor

alamb commented Aug 2, 2025

Hi @Adez017

hi @alamb , i coudnt find any rust file for this function .

I think you can find the corresponding rust file by searching for the function description. For example, to find abs search for "Returns the absolute value of a number." like this:

https://github.com/search?q=repo%3Aapache%2Fdatafusion+%22Returns+the+absolute+value+of+a+number.%22&type=code

If you are having problems running update_docs perhaps you can try using the codespace:

Screenshot 2025-08-02 at 6 22 00 AM

@Adez017
Copy link
Contributor Author

Adez017 commented Aug 5, 2025

Hi @Adez017

hi @alamb , i coudnt find any rust file for this function .

I think you can find the corresponding rust file by searching for the function description. For example, to find abs search for "Returns the absolute value of a number." like this:

https://github.com/search?q=repo%3Aapache%2Fdatafusion+%22Returns+the+absolute+value+of+a+number.%22&type=code

If you are having problems running update_docs perhaps you can try using the codespace:

Screenshot 2025-08-02 at 6 22 00 AM

just a quick question , does i need to install all dependencies over there or this are preconfigured

@alamb
Copy link
Contributor

alamb commented Aug 5, 2025

just a quick question , does i need to install all dependencies over there or this are preconfigured

they are pre-configured mostly

You may have to run this command in the container

apt-get install npm

(I made a PR to add this explicitly to the container here #17019)

@comphead
Copy link
Contributor

comphead commented Aug 6, 2025

@Adez017 this document is autogenerated by the ./dev/update_function_docs.sh script which runs separate rust console app to gather documentation from scalar functions documentation methods and creates an md file on top of that.

Do you see any issues with the tool?

@Adez017
Copy link
Contributor Author

Adez017 commented Aug 6, 2025

@Adez017 this document is autogenerated by the ./dev/update_function_docs.sh script which runs separate rust console app to gather documentation from scalar functions documentation methods and creates an md file on top of that.

Do you see any issues with the tool?

i haven't used yet , will do it later at EOD

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Fix]: Missing examples for Scalar Fucntions in docs
3 participants