docs: add local test data setup step#523
Open
samay2504 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates contributor documentation to include a short local workflow that ensures required example datasets are available before running tests.
Changes:
- Adds a “Local development and tests” section describing editable install with dev extras.
- Documents pre-fetching
libpysalexample datasets vialibpysal.examples.fetch_all()to avoid missing-data test failures. - Provides a basic command to run the test suite locally.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+15
to
+29
| ```bash | ||
| pip install -e ".[dev]" | ||
| ``` | ||
|
|
||
| 2. Download required example datasets before running tests: | ||
|
|
||
| ```bash | ||
| python -c "import libpysal; libpysal.examples.fetch_all()" | ||
| ``` | ||
|
|
||
| 3. Run the test suite: | ||
|
|
||
| ```bash | ||
| pytest spopt/tests/ | ||
| ``` |
There was a problem hiding this comment.
These fenced code blocks are indented with hard tab characters. GitHub-flavored Markdown can render tabs inconsistently inside ordered lists, and this also introduces literal tabs into the file. Prefer indenting the fenced blocks with spaces (typically 4 spaces under the list item) and update the other two blocks similarly for consistent rendering.
Suggested change
| ```bash | |
| pip install -e ".[dev]" | |
| ``` | |
| 2. Download required example datasets before running tests: | |
| ```bash | |
| python -c "import libpysal; libpysal.examples.fetch_all()" | |
| ``` | |
| 3. Run the test suite: | |
| ```bash | |
| pytest spopt/tests/ | |
| ``` | |
| ```bash | |
| pip install -e ".[dev]" | |
| ``` | |
| 2. Download required example datasets before running tests: | |
| ```bash | |
| python -c "import libpysal; libpysal.examples.fetch_all()" | |
| ``` | |
| 3. Run the test suite: | |
| ```bash | |
| pytest spopt/tests/ | |
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates contributor guidance with a short local workflow for editable installation, dataset preparation, and test execution, and it explicitly documents running
libpysal.examples.fetch_all()before tests so contributors avoid missing-data failures during local runs.