Skip to content

Improve description of function migration - #12743

Merged
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/improve_description
Oct 9, 2024
Merged

Improve description of function migration#12743
alamb merged 3 commits into
apache:mainfrom
alamb:alamb/improve_description

Conversation

@alamb

@alambalamb commented Oct 3, 2024

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Part of #12740

Rationale for this change

@Omega359 has created the basic framework for automatically generating content in #12668

There will be a period of transition as we migrate the existing content to the new code style

We should make it it very clear what is happening during this transition period

What changes are included in this PR?

Add heading and links to the different function pages explaining the transition

Here is an example:
Screenshot 2024-10-03 at 12 59 35 PM

Are these changes tested?

Are there any user-facing changes?

Improved docs, no functional changes

@github-actionsgithub-actionsBot added documentation Improvements or additions to documentation development-process Related to development process of DataFusion logical-expr Logical plan and expressions core Core DataFusion crate functions Changes to functions implementation labels Oct 3, 2024
@alamb
alambforce-pushed the alamb/improve_description branch from 28593da to 6b37c69CompareOctober 3, 2024 17:01
@alamb
alambforce-pushed the alamb/improve_description branch from 6b37c69 to de2f528CompareOctober 3, 2024 17:05
@github-actionsgithub-actionsBot removed logical-expr Logical plan and expressions core Core DataFusion crate functions Changes to functions implementation labels Oct 3, 2024
@alamb
alamb marked this pull request as ready for review October 4, 2024 11:11

@compheadcomphead left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm thanks @alamb

@alamb

alamb commented Oct 9, 2024

Copy link
Copy Markdown
ContributorAuthor

Thank you for the review @comphead 🙏

@Omega359

Copy link
Copy Markdown
Contributor

lgtm as well

@alamb
alamb merged commit e0b807b into apache:mainOct 9, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

development-processRelated to development process of DataFusiondocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alamb@Omega359@comphead