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

Document that AVA 4 cannot be run globally #3028

Merged
merged 2 commits into from
Jun 23, 2022

Conversation

binyamin
Copy link
Contributor

Resolves #3026

I added the note to /readme.md, instead of to /docs/08-common-pitfalls.md as discussed. I did this so I could put it directly under the installation instructions, which seemed the most appropriate place.

@novemberborn
Copy link
Member

Do you think it may fit better in the Running your tests section?

@binyamin
Copy link
Contributor Author

Maybe. But then the user might (1) install it globally, (2) try to run the tests, (3) look back at the documentation, and then (4) remove it globally and install it locally. If we added it to the installation section, it would make sure this wouldn't happen. Anyhow, that was my thought process.

Copy link
Member

@novemberborn novemberborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough. What do you think of my suggestion?

And then we could add your note in the Running your tests section so we've got our bases covered.

readme.md Outdated Show resolved Hide resolved
Co-authored-by: Mark Wubben <mark@novemberborn.net>
@novemberborn
Copy link
Member

Thanks @binyamin!

@novemberborn novemberborn merged commit ac0d75d into avajs:main Jun 23, 2022
@binyamin binyamin deleted the issue-3026 branch June 23, 2022 16:07
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.

Document that AVA 4 cannot be run globally
2 participants