Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Accept markdown long descriptions

See original GitHub issue

If a setup configuration tells long_description_content_type="text/markdown", then the long description should be checked for Markdown validity instead of ReST validity.

For example in pospell: https://github.com/JulienPalard/pospell/blob/master/setup.py#L13

PyPI renders it correctly: https://pypi.org/p/pospell

But pyroma whines:

pyroma .
------------------------------
Checking .
Found pospell
------------------------------
Your long_description is not valid ReST: 
<string>:41: (ERROR/3) Unexpected indentation.
<string>:39: (WARNING/2) Inline literal start-string without end-string.
<string>:52: (WARNING/2) Inline emphasis start-string without end-string.
<string>:55: (WARNING/2) Inline strong start-string without end-string.
<string>:55: (WARNING/2) Inline emphasis start-string without end-string.
<string>:57: (WARNING/2) Option list ends without a blank line; unexpected unindent.
<string>:59: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
<string>:59: (WARNING/2) Inline literal start-string without end-string.
<string>:59: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
------------------------------
Final rating: 9/10
Cottage Cheese
------------------------------

Issue Analytics

State:
Created 4 years ago
Reactions:2
Comments:5 (3 by maintainers)

Top GitHub Comments

3reactions

fniessinkcommented, Nov 4, 2019

Version 2.6 was released a couple of days ago. I can confirm it solves this issue.

0reactions

cthoytcommented, Sep 7, 2019

Is there a timeline for the 2.6 release?

Top Results From Across the Web

Extended Syntax | Markdown Guide

The basic Markdown syntax allows you to create code blocks by indenting lines by four spaces or one tab. If you find that...

Markdown Syntax Documentation

To this end, Markdown's syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so as to look like...

Handbook Markdown Guide - GitLab

Read through our Markdown kramdown Style Guide! ... Use panels when your description contains more than one paragraph, or a long paragraph.

Improving The Accessibility Of Your Markdown

In Markdown, an alternate description is placed in between the opening and ... This little detail can go a long way to helping...

How to wrap long lines inside of markdown ``` code ``` in ...

This should be accepted as the answer, easiest way to do this. – Guillochon. Apr 8, 2021 at 14:11. 5.