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

Run test from adding-udfs.md documentation #14485

Closed
wants to merge 20 commits into from

Conversation

ugoa
Copy link
Contributor

@ugoa ugoa commented Feb 4, 2025

Which issue does this PR close?

Closes #14435.

Rationale for this change

What changes are included in this PR?

  • docs/source/library-user-guide/adding-udfs.md

Are these changes tested?

Yes, but only for one document right now.

Are there any user-facing changes?

Yes? these are documentation enhancement

@github-actions github-actions bot added documentation Improvements or additions to documentation core Core DataFusion crate labels Feb 4, 2025
@ugoa ugoa mentioned this pull request Feb 4, 2025
13 tasks
@alamb
Copy link
Contributor

alamb commented Feb 4, 2025

😍

@alamb alamb changed the title Run test in all examples documentation Run test from adding-udfs.md documentation Feb 4, 2025
@alamb
Copy link
Contributor

alamb commented Feb 5, 2025

I took the liberty of running prettier and pushing the change to this branch

@ugoa
Copy link
Contributor Author

ugoa commented Feb 5, 2025

Thank you @alamb, it was fun to be exposed to all the internal APIs. 🙂

Although one major problem I have with using # to hide setup code, is that the sphinx won't respect the leading # and still renders the whole block, which leading huge chunk of ugly code blocks.. What do you recommend to addressing it?

Same comment left here.

@alamb
Copy link
Contributor

alamb commented Feb 5, 2025

Although one major problem I have with using # to hide setup code, is that the sphinx won't respect the leading # and still renders the whole block, which leading huge chunk of ugly code blocks.. What do you recommend to addressing it?

Yeah, what I hope we can do is find some way to add a sphinx plugin or something to avoid rendering the blocks of ugly code. We can maybe do this as a follow on PR / issue.

I will file a ticket for it

@ugoa
Copy link
Contributor Author

ugoa commented Feb 8, 2025

Closing this PR as I have moved the changes to PR 14544

@ugoa ugoa closed this Feb 8, 2025
@alamb
Copy link
Contributor

alamb commented Feb 8, 2025

Although one major problem I have with using # to hide setup code, is that the sphinx won't respect the leading # and still renders the whole block, which leading huge chunk of ugly code blocks.. What do you recommend to addressing it?

Yeah, what I hope we can do is find some way to add a sphinx plugin or something to avoid rendering the blocks of ugly code. We can maybe do this as a follow on PR / issue.

I will file a ticket for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run / Test all examples in Documentation
2 participants