search

python-lsp / pylsp-mypy

Mypy plugin for the Python LSP Server.
MIT License
127 stars 36 forks source link

Pypi crops first heading #14

Open Richardk2n opened 3 years ago

Richardk2n commented 3 years ago

When looking at pypi one can see, that the first line of the readme (Mypy plugin for PYLSP) is not present there. Any Ideas why?

hirosassa commented 3 years ago

Hi @Richardk2n, thanks for the great plugin!

From my quick survey, some projects reads README.{md, rst} directly instead of file: directive. For example, https://github.com/tox-dev/tox-pipenv/blob/master/setup.py#L11-L12

But I couldn't find the detailed reason.

jonas-w commented 1 year ago

Seems to be intended behaviour: https://github.com/pypa/readme_renderer/issues/260