pypa / readme_renderer

Safely render long_description/README files in Warehouse

Apache License 2.0

157 stars 88 forks source link

Status of markdown support #156

Closed ulope closed 5 years ago

ulope commented 5 years ago

The README claims that this module supports markdown: https://github.com/pypa/readme_renderer/blob/7bf7529296acfa7db0edf7914cb4571d691b63ee/README.rst#L6

55 seems to support this.

Yet looking at the code there seems to be no way to actually invoke the markdown render check.

Is that an oversight, or was markdown support removed again without updating the readme?

di commented 5 years ago

There's nothing to "check" for a Markdown readme as they will gracefully fail if there's invalid syntax, unlike reStructuredText. Any markdown readme will always be accepted by PyPI.

ulope commented 5 years ago

Ok fair enough.

The README should probably be updated to remove the reference to markdown then.

di commented 5 years ago

This project still supports rendering Markdown, which is it's primary purpose.