[ 
https://issues.apache.org/jira/browse/AVRO-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17306463#comment-17306463
 ] 

Subhash Bhushan commented on AVRO-3006:
---------------------------------------

Long descriptions in setup.cfg of both `py` and `py3` folders seem to be good, 
but I believe the content is incorrectly interpreted as Restructured Text.

There is a missing config attribute in `setup.cfg` to tell Pypi to read the 
file content as markdown: `long_description_content_type='text/markdown'` 
([Source|https://packaging.python.org/guides/making-a-pypi-friendly-readme/#including-your-readme-in-your-package-s-metadata])

I can add this and push to see if this solves the problem, [~kojiromike]. 
Please confirm.

> Update documentation on pypi
> ----------------------------
>
>                 Key: AVRO-3006
>                 URL: https://issues.apache.org/jira/browse/AVRO-3006
>             Project: Apache Avro
>          Issue Type: Improvement
>          Components: python
>    Affects Versions: 1.11.0
>            Reporter: Michael A. Smith
>            Assignee: Michael A. Smith
>            Priority: Major
>             Fix For: 1.11.0
>
>
> The avro python packages have outdated or missing documentation at
> https://pypi.org/project/avro-python3/ (which should state that this package 
> is deprecated in favor of…)
> https://pypi.org/project/avro/ (which should have a document describing the 
> package and should correctly state which version of Python it supports)



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to