The test instructions on the README.md file – for copy paste heads like myself – can lead the library user to a journey on the wrong side of the testing streets.
This PR clarifies and fixes the instructions for the default behaviour of the lib, that probably 90% of the people use.
Didn't look, but suspect that, at some point in the library history that was the default realm and it got carried on the README.md since.
The root of the problem is probably a DRY violation between code and documentation (in this case the README.md). My fix is not ambitious enough to fix that problem.
yordis
commented
3 years ago
The test instructions on the
README.mdfile – for copy paste heads like myself – can lead the library user to a journey on the wrong side of the testing streets.This PR clarifies and fixes the instructions for the default behaviour of the lib, that probably 90% of the people use. Didn't look, but suspect that, at some point in the library history that was the default realm and it got carried on the
README.mdsince.The root of the problem is probably a DRY violation between code and documentation (in this case the
README.md). My fix is not ambitious enough to fix that problem.Thanks for all the hard work on guardian. 🥇