bear / python-twitter

A Python wrapper around the Twitter API.
Apache License 2.0
3.41k stars 955 forks source link

Fix for PyPI's README not being rendered correctly. #696

Closed yu9824 closed 2 years ago

yu9824 commented 2 years ago

Dear Developers,

Thank you very much for your help.

I was looking at the PyPI site of this project. And I found that the rich text was not compiling the right way, resulting in a broken layout.

So I tried to find out the cause of the problem. The reasons are the following two points.

  1. "---" which indicates paragraph titles, is too short.
  2. the "CHANGES" file contains indentations.

Adding some "-" solves problem 1. The function which I added in setup.py solves problem 2.

I have confirmed on the PyPI test server that these fixes make the compilation work.

Another possible solution is to remove the "CHANGES" file from the PyPI long_descrition. However, I decided that it would be better to include the file and took the above solution.

I hope you will consider it.

Sincerely,


This change is Reviewable