Description can now be amended per package #11
Merged
Conversation
This file contains hidden or 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
The extra_description field in METADATA.toml now gets added to the package's long_description field.
ilevkivskyi
approved these changes
May 12, 2021
scripts/build_wheel.py
Outdated
| @@ -53,6 +53,8 @@ | |||
| https://github.com/python/typeshed/tree/master/stubs/{distribution}. All fixes for | |||
| types and metadata should be contributed there. | |||
|
|
|||
| {extra_description} | |||
There was a problem hiding this comment.
Maybe only add the extra newlines if the extra description is non-empty?
There was a problem hiding this comment.
I think that multiple empty lines should result in only one new paragraph in markdown, but I'm not certain that's true and whether all markdown renderers do that.
Should I just split the constant and use string concat?
There was a problem hiding this comment.
How you did with having parts looks good.
Extract long description generation into separate function. Split long description intro and outro into separate templates.
|
@ilevkivskyi I have rewritten the long description generation, also in preparation of #12. This should avoid extra empty lines. |
ilevkivskyi
approved these changes
May 12, 2021
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.
The extra_description field in METADATA.toml now gets added
to the package's long_description field.