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

Update and expand UDF docs #24441

Merged
merged 6 commits into from
Dec 16, 2024
Merged

Update and expand UDF docs #24441

merged 6 commits into from
Dec 16, 2024

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Dec 10, 2024

Description

Main updates are to rebrand from "SQL routines" to "User-defined functions (UDFs)" and "SQL user-defined functions", rejig all the content so it is an appropriate base, and then add "Python user-defined functions".

More details in the commit messages since there is a lot happening.

Note to reviewers: Review per commit and potentially build locally to see rendered output. When rewording paragraphs and such wrapping was also always fixed/updated.

Additional context and related issues

#24378

Release notes

Note sure yet .. we might want to add a release note even though this should not break anything or have any user facing context itself.. just so its clear that we are rebranding.

( ) This is not user-visible or is docs only, and no release notes are required.
( ) Release notes are required. Please propose a release note for me.
( ) Release notes are required, with the following suggested text:

## Section
* Fix some things. ({issue}`issuenumber`)

Copy link
Member

@electrum electrum left a comment

Choose a reason for hiding this comment

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

Looks great!

docs/src/main/sphinx/admin/properties-sql-environment.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/python.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/python.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/python.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/python.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/udf/python.md Outdated Show resolved Hide resolved
@mosabua mosabua marked this pull request as ready for review December 16, 2024 16:50
Move them in appropriate folders for user-defined functions
and SQL user-defined functions. Update all references so that
the docs build process fully works.
And generally introduce user-defined functions (UDF) as a term.
Into the separate page, and adjust the generic content to be suitable
for any UDF language.
Into the separate page, and adjust the generic content to be suitable
for any UDF language.
@mosabua mosabua force-pushed the udf branch 3 times, most recently from c92941f to f7aeb5e Compare December 16, 2024 17:56
@mosabua mosabua merged commit 893fc42 into trinodb:master Dec 16, 2024
4 of 5 checks passed
@mosabua mosabua deleted the udf branch December 16, 2024 20:37
@github-actions github-actions bot added this to the 468 milestone Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants