sungwy opened a new issue, #1056: URL: https://github.com/apache/iceberg-python/issues/1056
### 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: https://github.com/apache/iceberg-python/blob/e891bcddb1584c6b7a35b61537ab5802b514ec6d/pyiceberg/table/__init__.py#L1396-L1410 https://github.com/apache/iceberg-python/blob/e891bcddb1584c6b7a35b61537ab5802b514ec6d/pyiceberg/table/__init__.py#L1447-L1465 I think that the Google style guide for [Comments and Docstrings is a good start](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings), 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) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
