docs: add docstrings to InspectTable public methods (closes #1191)#3555
Open
ritesxh wants to merge 1 commit into
Open
docs: add docstrings to InspectTable public methods (closes #1191)#3555ritesxh wants to merge 1 commit into
ritesxh wants to merge 1 commit into
Conversation
Closes apache#1191 Added Google-style docstrings to all public methods of InspectTable in pyiceberg/table/inspect.py: - __init__: parameters and ModuleNotFoundError - snapshots, entries, refs, partitions: full schema descriptions + examples - manifests, metadata_log_entries, history: schema + examples - files, data_files, delete_files: content column semantics + examples - all_manifests, all_files, all_data_files, all_delete_files: cross-snapshot de-duplication behaviour documented Private helpers (_get_snapshot, _get_files_from_manifest, _generate_manifests_table) also received brief docstrings for maintainability.
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.
Summary
Closes #1191
Added comprehensive Google-style docstrings to all public methods of
InspectTableinpyiceberg/table/inspect.py.Methods documented
__init__ModuleNotFoundErrorsnapshots()entries()statusvalue meanings, examplerefs()partitions()row_filter/case_sensitiveargs, examplemanifests()metadata_log_entries()history()is_current_ancestorsemantics, examplefiles()contentcolumn values (0/1/2), exampledata_files()delete_files()all_manifests()reference_snapshot_id, exampleall_files()all_data_files()all_delete_files()Private helpers (
_get_snapshot,_get_files_from_manifest,_generate_manifests_table) also received brief docstrings for maintainability.Changes
pyiceberg/table/inspect.py— docstrings only, no logic changes