Fix PyPi description does not render #879 #883
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a test to check for this via tox env `package-description`. Using collective.checkdocs and `python setup.py checkdocs`. Note we could use restview too, however that requires a compilation step so decided against it. Users can use on an ad-hoc level the command `restview --pypi-strict --long-description` to visualize locally PyPi description.
Codecov Report
@@ Coverage Diff @@
## master #883 +/- ##
==========================================
+ Coverage 91.03% 92.49% +1.45%
==========================================
Files 12 12
Lines 2331 2331
Branches 408 408
==========================================
+ Hits 2122 2156 +34
+ Misses 142 110 -32
+ Partials 67 65 -2
Continue to review full report at Codecov.
|
|
What is the reason for not using From the old This is the exact same tool that pypa uses for rendering in warehouse so I would say we should use this also to check. |
|
Hmmm missed that that's what upstream uses will amend. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a test to check for this via tox env
package-description. Using collective.checkdocs andpython setup.py checkdocs. Note we could use restview too, however that requires a compilation step so decided against it. Users can use on an ad-hoc level the commandrestview --pypi-strict --long-descriptionto visualize locally PyPi description.Resolves #879.