search

pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 88 forks source link

Ignore unknown directive options rather than aborting #199

Open terencehonles opened 3 years ago

terencehonles commented 3 years ago

This is the same as my PR https://github.com/github/markup/pull/1452 and it may make sense to incorporate other changes from GitHub's rST processing.

terencehonles commented 3 years ago

I didn't look at the code too closely, but it may make sense to see if these can surfaced as warnings which would still fail with twine check --strict but would not prevent the rST from rendering. I had made the change on GitHub since it silently would drop documentation examples and it appears that's the same for PyPI, but since twine check and possibly others consume this library the unknown options could possibly still be passed up without blowing up.

terencehonles commented 3 years ago

@di not sure if you have any input on this, sorry to bother if you're the wrong person to ask.

miketheman commented 2 years ago

Related to #160