search

hydrosquall / tiingo-python

Python client for interacting with the Tiingo Financial Data API (stock ticker and news data)
https://pypi.org/project/tiingo/
MIT License
244 stars 52 forks source link

Convert README.rst to Markdown #266

Open hydrosquall opened 5 years ago

hydrosquall commented 5 years ago

RST is harder to work with and shrinking in usage. If we can confirm that markdown works well for the pieces that depend on it (sphinx docs, Python Package warehouse), the project documentation will be easier to maintain. It will also make adhering to projects like the all-contributors specification easier.

https://github.com/all-contributors/all-contributors

hootnot commented 5 years ago

If you stick with RST you should change the header from:

=============
Tiingo Python
=============

to:

Tiingo Python
=============

then pypi.org will render the README.rst correct

hydrosquall commented 5 years ago

Oh, I had been wondering about why that wasn’t working! Thank you for catching that. If you’re interested in filing a PR for this I will merge it, otherwise I’ll get to it when I deploy a new tiingo version this weekend.

On Tue, May 7, 2019 at 7:51 AM Feite Brekeveld notifications@github.com wrote:

If you stick with RST you should change the header from:

============= Tiingo Python

to:

Tiingo Python

then pypi.org will render the README.rst correct

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/hydrosquall/tiingo-python/issues/266#issuecomment-490047091, or mute the thread https://github.com/notifications/unsubscribe-auth/ACE2MM7OOQXL7CUPFIP7NSLPUFUL5ANCNFSM4HK4ANHA .

hootnot commented 5 years ago

Hi, pls. make the change yourself and bundle it with your deploy for the weekend. You should also check all other headers for the length of '-' or other valid header markup characters.

I'm not sure if these would break the rendering, but the specs say the length should be equal.

Cheers

hydrosquall commented 5 years ago

By default, an upload's description will render with reStructuredText. If the description is in an alternate format like Markdown, a package may set the long_description_content_type in setup.py to the alternate format.

Learned today that this can be linted using the readme_renderer, via twine check dist/*. The last remaining linting issue was to ensure that every underline is at least as long as the preceding line.