kevinjqliu commented on issue #1529: URL: https://github.com/apache/iceberg-python/issues/1529#issuecomment-2597061263
Thanks for reporting this! Its helpful to have those variables available and linked in the docs. For context, we use `mkdocstrings` to generate docs from the source code. I think the current problem is that variables such as `Identifier` , `Properties` and `RecursiveDict` are [not recognized in the docs under typedef](https://py.iceberg.apache.org/reference/pyiceberg/typedef/). And because its not recognized, the rest of the docs are not able to hyperlink to it. A potential solution is to add docstring to the variables. The docstrings should force `mkdocstrings` to recognize these as part of the docs. from https://mkdocstrings.github.io/python/#features: > Support for documented attributes: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by Griffe in modules, classes and even in __init__ methods. -- 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 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
