jiangxt2 opened a new issue, #14361: URL: https://github.com/apache/gravitino/issues/14361
### What would you like to be improved? The Python client already includes type annotations, docstrings, and user documentation, but their coverage and consistency vary. Some public wrappers lack return annotations, and some Python docstrings still contain Java descriptions or Javadoc syntax. This reduces editor assistance and makes parameters, return values, exceptions, and resource ownership harder to understand. Unity Catalog OSS combines typed models and mypy configuration with an API documentation generation workflow. These provide useful references for improving Gravitino's existing public API and model system. [UC configuration](https://github.com/unitycatalog/unitycatalog/blob/35df64c579b94990d8d315e8d804b265f0a4ee58/clients/python/build/pyproject.toml), [documentation workflow](https://github.com/unitycatalog/unitycatalog/blob/35df64c579b94990d8d315e8d804b265f0a4ee58/clients/python/README.md#building-docs-for-release) ### How should we improve? - Agree on a bounded initial set of public methods and models, then fill missing or inaccurate annotations according to actual runtime behavior. - Correct misleading docstrings and document parameters, return values, exceptions, resource ownership, and applicable capability boundaries. - Provide runnable examples and link to authoritative installation and compatibility guidance. - Add scoped static type checks and verify representative examples for the agreed public surface. - Preserve existing public names, runtime behavior, and model serialization contracts. Broader API redesign and REST/DTO generation remain separate work. Parent epic: #14334. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
