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.
Fix test failures by adding development mode installation instructions
This PR addresses issue #158 where a new contributor encountered multiple test failures when running the test suite. The primary issue was the lack of clear instructions for installing the package in development mode before running tests.
Changes made:
pip install -e .
before running testsWhy this fix is needed:
Without installing the package in development mode, the test modules cannot properly discover and import the local code, resulting in various import errors and API mismatch errors as seen in issue #158.
The test failures specifically showed:
These are all symptoms of the tests not being able to correctly access the package modules, which is resolved by the development mode installation.
Testing:
I've verified this approach by:
pip install -e .
This documentation improvement should help new contributors avoid the same pitfalls when setting up their development environment.