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.

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

Remove unnecessary usage of readme_renderer.markdown #421

merged 1 commit into from Oct 29, 2018


5 participants
Copy link

commented Oct 28, 2018

Fixes #420.

Rendering plaintext or markdown will never fail, so we'll just automatically pass the check if those content types have been specified.


This comment has been minimized.

Copy link

commented Oct 28, 2018

Codecov Report

Merging #421 into master will decrease coverage by 0.05%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #421      +/-   ##
- Coverage   78.29%   78.23%   -0.06%     
  Files          14       14              
  Lines         737      735       -2     
  Branches      106      106              
- Hits          577      575       -2     
- Misses        127      128       +1     
+ Partials       33       32       -1
Impacted Files Coverage Δ
twine/commands/ 100% <100%> (ø) ⬆️
twine/ 31.57% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd1d8b0...ee131f3. Read the comment docs.

@sigmavirus24 sigmavirus24 merged commit 79b1c2f into pypa:master Oct 29, 2018

3 checks passed

codecov/patch 100% of diff hit (target 78.29%)
codecov/project Absolute coverage decreased by -0.05% but relative coverage increased by +21.7% compared to bd1d8b0
continuous-integration/travis-ci/pr The Travis CI build passed

PyPA Sprint Weekend at Bloomberg (2018) automation moved this from Submitted PRs to Merged PRs Oct 29, 2018

@di di deleted the di:fix/420 branch Nov 19, 2018

@obestwalter obestwalter referenced this pull request Jan 2, 2019


Improve README #1114


This comment has been minimized.

Copy link

commented Jan 2, 2019

Rendering plaintext or markdown will never fail

Does that mean that the check does not really do anything in case of markdown?


This comment has been minimized.

Copy link

commented Jan 2, 2019

That's correct. Cmark does not error when it's given malformed markup, it will mostly just pass it through, being careful to close any dangling html tag if necessary.


This comment has been minimized.

Copy link

commented Jan 23, 2019

Temporary work around is to pip install readme_renderer[md]

@matthewfeickert matthewfeickert referenced this pull request Feb 19, 2019


PyPI documentation not rendered properly #410

3 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.