Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pypi crops first heading #14

Open
Richardk2n opened this issue Jul 3, 2021 · 4 comments
Open

Pypi crops first heading #14

Richardk2n opened this issue Jul 3, 2021 · 4 comments
Labels
help wanted Extra attention is needed question Further information is requested

Comments

@Richardk2n
Copy link
Member

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?
@Richardk2n Richardk2n added help wanted Extra attention is needed question Further information is requested labels Jul 3, 2021
@hirosassa
Copy link

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
Copy link

jonas-w commented Aug 15, 2023

Seems to be intended behaviour:
pypa/readme_renderer#260

@jgarte

This comment was marked as spam.

Sign in to view
@Richardk2n
Copy link
Member Author

Please refrain from unnecessary comments.
As was pointed out, this is intended behavior and therefore this issue is “solved”.
It is still open to remind me to rework the README some day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@hirosassa @Richardk2n @jonas-w @jgarte