FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: document null-handling function arguments by BharatDeva · Pull Request #1527 · apache/datafusion-python · GitHub

/ datafusion-python Public

docs: document null-handling function arguments - #1527

Merged
timsaucer merged 1 commit into
apache:mainfrom
BharatDeva:docs/function-null-argument-docs
May 28, 2026
ConversationCommits (1)ChecksFiles changed
Merged

docs: document null-handling function arguments#1527
timsaucer merged 1 commit into
apache:mainfrom
BharatDeva:docs/function-null-argument-docs

Conversation

BharatDeva commented May 9, 2026 •
edited by timsaucer
Loading

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Related to #1463.

Rationale for this change

Some function docstrings in python/datafusion/functions.py include 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:

  • coalesce
  • ifnull
  • nanvl
  • nvl
  • nvl2

Are 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.py
    • Result: All checks passed!
  • uv tool run ruff@0.15.1 format --check --config pyproject.toml python/datafusion/functions.py
    • Result: 1 file already formatted
  • git diff --check
    • Result: passed with no whitespace errors

LLM-generated code disclosure

This documentation update was prepared with assistance from OpenAI Codex and manually reviewed before submission.

timsaucer mentioned this pull request May 27, 2026
Open
10 tasks

timsaucer commented May 27, 2026

Copy link
Copy Markdown
Member

I don't think this PR closes the linked issue. Also it states that these arguments are not documented but my read of each one does include documentation of what the variables are. They are not laid out in an Args: section but these are also nearly one line argument descriptions. This PR seems more pedantic than adding significant value. @BharatDeva can you expand a little on why you think the existing documentation is insufficient?

coracuity approved these changes May 28, 2026
View reviewed changes

coracuity left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good, thanks so much!

coracuity commented May 28, 2026

Copy link
Copy Markdown

Ahh I didn't read the source issue, just that it sets out to do what it text here explains.

coracuity commented May 28, 2026

Copy link
Copy Markdown

@timsaucer these descriptions are very similar to what's found here https://datafusion.apache.org/user-guide/sql/scalar_functions.html#nvl

timsaucer merged commit 23f9179 into apache:main May 28, 2026
21 checks passed

timsaucer commented May 28, 2026

Copy link
Copy Markdown
Member

Since the original reporter is happy with it, I'm merging

stantheman0128 mentioned this pull request Aug 12, 2026
Open
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
coracuity coracuity approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL