Add docstrings to pyiceberg/table/inspect.py#3457
Open
RyukR1 wants to merge 1 commit into
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
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.
closes #1191
Rationale for this change
pyiceberg/table/inspect.pyhad no docstrings on any of its publicor private methods. This PR adds Google-style docstrings to all
methods of the
InspectTableclass, including the class-leveldocstring. This improves discoverability and makes the API
self-documenting.
Are these changes tested?
make test— 296 table tests pass ✅make lint— all 12 checks pass includingpydocstyleandmypy✅Are there any user-facing changes?
No. Docstrings only — no behavior or API changes.