fix doc8 RuntimeWarning
#437
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
resolves "RuntimeWarning: 'doc8.main' found in sys.modules after import of package 'doc8', but prior to execution of 'doc8.main'; this may result in unpredictable behaviour" by changing doc8 execution from "doc8.main" to "doc8"
|
|
|
This warning only occurs after a certain doc8 version upgrade. So this pull request should add version check before being merged. |
|
Looks like |
|
@ITProKyle That's already tremendous help. Thanks. |
|
This has been merged and shipped in latest preview 190.1.19. |
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.
resolves
RuntimeWarning: 'doc8.main' found in sys.modules after import of package 'doc8', but prior to execution of 'doc8.main'; this may result in unpredictable behaviourby changing doc8 execution from "doc8.main" to "doc8".The above screenshot shows this warning being reported in
PROBLEMS.The warning is caused by
doc8.__init__importingdoc8.mainresulting inpython -m doc8.maincausing the import to happen twice.python -m doc8resolves this asdoc8.__main__implements the execution ofdoc8.mainwhen called this way.Note I was unable to get
yarn run pretest && yarn run testto run locally so relying on GitHub actions to perform tests and show me what else needs to be updated.