Make description look nice on pypi

ethereum / eth-typing

Python types for type hinting commonly used ethereum types

MIT License

31 stars 35 forks source link

Make description look nice on pypi #17

Closed cburgdorf closed 5 years ago

cburgdorf commented 5 years ago

What was wrong?

The markdown description isn't rendered correctly on pypi.

How was it fixed?

Use long_description and long_description_content_type as we did in a bunch of other repos to cure this

Cute Animal Picture

put a cute animal picture link inside the parentheses

carver commented 5 years ago

So when I notice that a repo isn't up to snuff, the first thing I check is if it's based on the template (since often the problem is fixed in the template). Looks like this repo is template-based, so a merge-in of template changes should probably bring lots of nice improvements! :)

Maybe I'll run through the process one more time, and write up the template upgrade process to make it more approachable for everyone.