Tests: Add missing dependency and improve documentation #37
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.
Dear maintainers of
magics-python
,first things first: Thanks a stack for your work on this software.
While trying to investigate a problem with
Magics.version
on macOS, we discovered some gaps in the documentation how to run the test suite. After figuring it out, we wanted to share it back on behalf of improvements to the documentation.So, this patch fills in some gaps to educate people how to exactly run the full test suite. Along the lines, it adds the missing
pytest-flakes
package.Within the README, it adds a note about setting the
MAGPLUS_HOME
environment variable, which is helpful in non-standard setup location environments.With kind regards,
Andreas.