docs: clarify table write API docstrings#3346
Open
BharatDeva wants to merge 1 commit intoapache:mainfrom
Open
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
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.
Rationale for this change
Issue #1056 tracks missing or incomplete docstrings in PyIceberg public APIs. While reviewing the table write helpers, I noticed a few small gaps in the
TableAPI docs:appenddescribed the input dataframe as overwriting the table, although the method appends rows.add_filesdocumented onlyfile_paths, even though the public method also accepts snapshot properties, duplicate-file checking, and branch selection.update_specdid not have a public docstring, unlike the surrounding table update helpers.What changes are included in this PR?
This PR makes a small documentation-only update to
pyiceberg/table/__init__.py:appendargument descriptionadd_filesargument descriptionsupdate_specdocstring with itscase_sensitiveargumentAre these changes tested?
Yes. I ran the following local checks:
uv tool run [email protected] check --config pyproject.toml pyiceberg/table/__init__.pyAll checks passed!uv tool run [email protected] --ignore=D100,D102,D101,D103,D104,D107,D203,D212,D213,D404,D405,D406,D407,D411,D413,D415,D417 pyiceberg/table/__init__.pygit diff --checkAre there any user-facing changes?
Yes, documentation-only. The public API docs are clearer, but runtime behavior is unchanged.
LLM-generated code disclosure
This documentation update was prepared with assistance from OpenAI Codex and manually reviewed before submission.