Basic guide and some tidying up #74
Merged
Conversation
This file contains 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
Contributor
ageorgou
commented
Sep 30, 2022
ageorgou
commented
- Filled in the README with some context and instructions
- Added a license (chose MIT but don't have particular concerns)
- Removed an earlier attempt at a second command that was not being used anywhere
README.md
Outdated
|
|
||
| ### Testing | ||
| The package comes with unit tests. To run them, simply run | ||
| `pytest` from the top level (this directory). The `pytest` package and command are installed during |
There was a problem hiding this comment.
[...] installed during [the pip install]?
|
The tests are failing because of a bug in pandas 1.5.0, which should be fixed in the next release. |
pineapple-cat
approved these changes
Oct 7, 2022
It's not just tests but also other tools, including documentation.
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.