Open
Description
Feature Request / Improvement
As we prepare for a major release, I think it would be great to hold our public APIs to a higher standard of documentation.
Many popular public classes, methods and functions are currently missing docstrings.
Here are some examples:
iceberg-python/pyiceberg/table/__init__.py
Lines 1396 to 1410 in e891bcd
iceberg-python/pyiceberg/table/__init__.py
Lines 1447 to 1465 in e891bcd
I think that the Google style guide for Comments and Docstrings is a good start, as it has a easily human-readable format that includes description, args, returns and exceptions that is also Sphinx parse-able (if we ever decide to autogenerate API docs that way in the future)
TODO: