Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1191:Added docstrings to the pyiceberg/table/inspect.py file #1533

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
+423 −235
Open

1191:Added docstrings to the pyiceberg/table/inspect.py file #1533

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
14a607a
Added docstrings to the inspect.py file
Jan 17, 2025
f71235c
Added docstrings to pyiceberg/table/inspect.py for better documentation
Jan 17, 2025
a8f41d1
Refined docstrings in inspect.py and updated related files
Jan 21, 2025
6c180a9
Fixed linter error
Jan 30, 2025
1dfd302
Removed mkdocs dependency and updated lock file
Feb 1, 2025
5fc6489
Remove .python-version file and revert changes in SUMMARY.md
Feb 3, 2025
85a21ac
Reverted the changes to mkdocs/mkdocs.yml, poetry.lock, and pyproject…
Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .python-version
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

this is part of pyenv's local config, should not be checked into the repo

Copy link
Author

Choose a reason for hiding this comment

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

Got it! I will remove .python-version from the PR.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
3.9.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you remove this file?

3.10.0
3.11.0
3.12.0
2 changes: 1 addition & 1 deletion mkdocs/docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
- [Verify a release](verify-release.md)
- [How to release](how-to-release.md)
- [Release Notes](https://github.com/apache/iceberg-python/releases)
- [Code Reference](reference/)
- [Code Reference](reference/pyiceberg/index.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

why was this changed? i dont think this is necessary

Copy link
Author

Choose a reason for hiding this comment

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

I will remove the change from the SUMMARY.md file if it's not necessary. Thanks for pointing it out!

Copy link
Contributor

Choose a reason for hiding this comment

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

Please revert the change so we can get this in :)


<!-- markdown-link-check-enable-->

Expand Down
3 changes: 2 additions & 1 deletion mkdocs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ plugins:
- mkdocstrings:
handlers:
python:
paths: [..]
paths:
- pyiceberg
Copy link
Contributor

Choose a reason for hiding this comment

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

same for this, what is this change for?

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for pointing this out! I made this change while addressing errors in inspect.py. However, I’ll review it again to ensure it’s necessary and aligned with the overall structure. Please let me know if you have additional context or suggestions.


theme:
name: material
Expand Down
Loading