[
https://issues.apache.org/jira/browse/AVRO-3107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17377698#comment-17377698
]
Michael A. Smith commented on AVRO-3107:
----------------------------------------
I think good docs would be great. However, there are going to be some rough
patches in that the API is somewhat inconsistent. This has been one of the
challenges of type annotating avro Python. So documenting some things in the
api may require some research and care to get right.
> Python API documentation isn't available
> ----------------------------------------
>
> Key: AVRO-3107
> URL: https://issues.apache.org/jira/browse/AVRO-3107
> Project: Apache Avro
> Issue Type: New Feature
> Components: doc, python
> Reporter: Spencer Nelson
> Priority: Major
>
> It's entirely possible that I'm missing something, but I can't find
> documentation for the Python API.
>
> It used to exist, long ago; I can find docs for version 1.2.0 and earlier:
> * [https://avro.apache.org/docs/1.2.0/api/py/avro.io.html]
> * [https://avro.apache.org/docs/1.0.0/api/py/avro.io.html]
> But that link pattern stops working for 1.3+. Now there doesn't appear to be
> full documentation of the Python API. There's a brief and informal "getting
> started guide"
> ([https://avro.apache.org/docs/current/gettingstartedpython.html)] but it
> isn't very thorough, and doesn't explain which parts of the published modules
> are covered by any API stability.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
