docs: document null-handling function arguments#1527
Open
BharatDeva wants to merge 1 commit intoapache:mainfrom
Open
docs: document null-handling function arguments#1527BharatDeva wants to merge 1 commit intoapache:mainfrom
BharatDeva wants to merge 1 commit intoapache:mainfrom
Conversation
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
1 participant
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?
Closes #1463.
Rationale for this change
Some function docstrings in
python/datafusion/functions.pyinclude examples but do not describe their arguments. This makes the generated API docs harder to scan when users are looking up function signatures.This PR makes a small, focused pass over the related null-handling helpers.
What changes are included in this PR?
Adds
Args:sections for:coalesceifnullnanvlnvlnvl2Are there any user-facing changes?
Yes, documentation-only. The generated API docs will include clearer argument descriptions for these functions. Runtime behavior is unchanged.
Validation
uv tool run ruff@0.15.1 check --config pyproject.toml python/datafusion/functions.pyAll checks passed!uv tool run ruff@0.15.1 format --check --config pyproject.toml python/datafusion/functions.py1 file already formattedgit diff --checkLLM-generated code disclosure
This documentation update was prepared with assistance from OpenAI Codex and manually reviewed before submission.