Add docstring examples for Common utility functions#1419
Open
ntjohnson1 wants to merge 1 commit intoapache:mainfrom
Open
Add docstring examples for Common utility functions#1419ntjohnson1 wants to merge 1 commit intoapache:mainfrom
ntjohnson1 wants to merge 1 commit intoapache:mainfrom
Conversation
Add example usage to docstrings for Common utility functions to improve documentation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
kosiew
reviewed
Mar 13, 2026
Contributor
kosiew
left a comment
kosiew
left a comment
There was a problem hiding this comment.
@ntjohnson1
Thanks for working on this.
Comment on lines
+382
to
+383
| >>> result = df.select( | ||
| ... dfn.functions.array_join(dfn.col("a"), dfn.lit("-")).alias("s")) |
Contributor
There was a problem hiding this comment.
array_join, list_to_string, and list_join are all aliases of array_to_string, but each now carries its own slightly different example.
I think keeping the full runnable example on the canonical function and letting the aliases point to it to avoid three extra snippets to maintain whenever the preferred usage changes.
Comment on lines
+508
to
+509
| Parameters: | ||
| ----------- |
Contributor
There was a problem hiding this comment.
This docstring switches from the file’s more common Args: convention to Parameters:.
It would be cleaner to keep the surrounding style consistent and add the example without changing the docstring format for just this one helper.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
Add example usage to docstrings for Common utility functions to improve documentation.
What changes are included in this PR?
The first PR was basically adding a docstring to everything in functions. I broke it apart into a PR (that already merged) for the infra. I then reviewed and merged an example PR of adding the docstrings in parts. This is now the follow up opening a handful of PRs for the remaining functions in functions.py Everything is co-authored with Claude since I used claude to extend the handwritten examples I wrote for reference and to split apart the large PR rather than doing it manually.
I've reviewed all the code prior to PR.
Are there any user-facing changes?
No