Packaging Python Projects: Make packaging-problems link more prominent#922
Merged
Packaging Python Projects: Make packaging-problems link more prominent#922
Conversation
webknjaz
reviewed
Jun 19, 2021
| show you how to add the necessary files and structure to create the package, how | ||
| to build the package, and how to upload it to the Python Package Index. | ||
|
|
||
| .. note:: If you have trouble running the commands in this tutoral, please copy the |
Member
There was a problem hiding this comment.
For admonitions, it's common to have an indented paragraph as their block arguments. Could you reflow it as follows:
Suggested change
| .. note:: If you have trouble running the commands in this tutoral, please copy the | |
| .. tip:: | |
| If you have trouble running the commands in this tutoral, please copy the |
Also, it's a "tip" rather than "note", I think.
Contributor
Author
There was a problem hiding this comment.
Done. Thanks for the tip. ;)
webknjaz
reviewed
Jun 19, 2021
| .. note:: If you run into trouble here, please copy the output and file an issue | ||
| over on `packaging problems`_ and we'll do our best to help you! | ||
|
|
||
| .. _packaging problems: |
Member
There was a problem hiding this comment.
I like a detached reference definition better since it allows us to have shorter lines (it's already quite long).
webknjaz
approved these changes
Jun 19, 2021
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #866
Rather than isolating it to the
python -m buildstep, my hope is that this lets readers know then can get help at any point along the way. I thought about adding internal links to the.. noteto the various steps, or adding specific?title=links, but I also thought that might be unnecessarily noisy.Sorry for the duplicate of #921 ; I renamed the branch in the GitHub UI, thinking it might carry over into the PR.