Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests: Add missing dependency and improve documentation #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

amotl
Copy link

@amotl amotl commented Oct 23, 2021

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.

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.
@FussyDuck
Copy link

FussyDuck commented Oct 23, 2021

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants