fix: try harder to avoid a common user mistake#856
Merged
Conversation
henryiii
commented
Mar 9, 2021
Comment on lines
-204
to
+203
| .. code-block:: python | ||
| .. warning:: |
Contributor
Author
There was a problem hiding this comment.
This provides a red box, while the IMPORTANT admonition didn't do anything very special.
Member
There was a problem hiding this comment.
Hopefully, changing the theme to furo or the one @pradyunsg is working on will improve this
FFY00
reviewed
Mar 9, 2021
| installs. This file used to be required, but can be omitted in modern | ||
| setuptools. If you include the file, you must have a call to | ||
| :func:`setup()` in it: | ||
| setuptools. |
Member
There was a problem hiding this comment.
Don't you still need to call setup() if you include it?
Contributor
Author
There was a problem hiding this comment.
This just moved to a red box with a warning. See the line below.
Member
There was a problem hiding this comment.
I guess I should wait a bit after waking up to give feedback on PRs 🤦
Member
There was a problem hiding this comment.
Contributor
Author
|
|
webknjaz
reviewed
Mar 9, 2021
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
webknjaz
reviewed
Mar 9, 2021
webknjaz
approved these changes
Mar 9, 2021
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
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
3 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 #838. This should make a common user mistake harder.
I do think this should produce a better error message, though, when
setup.pydoes not contain a call tosetuptools.setup(). Possibly via a change to setuptools or pip?