pydra
pydra copied to clipboard
WIP: few minor edits
Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Summary
Checklist
- [ ] All tests passing
- [ ] I have added tests to cover my changes
- [x] I have updated documentation (if necessary)
- [ ] My code follows the code style of this project
(we are using
black
: you canpip install pre-commit
, runpre-commit install
in thepydra
directory andblack
will be run automatically with each commit)
Acknowledgment
- [x] I acknowledge that this contribution will be available under the Apache 2 license.
@zswgzx - thank you, but before you do too much, for pydra we will use the numpydoc style for a lot of docstrings: https://numpydoc.readthedocs.io/en/latest/format.html
if you are using something like pycharm you can set this using Preferences/Settings->Tools->Python Integrated Tools->Docstring Format
this hasn't been consistent, but let's do this from here on out.
updated
@zswgzx - thank you! Some tests are failing, do you want to check it. Have you tried to run tests locally using pytest?
@zswgzx - thank you! Some tests are failing, do you want to check it. Have you tried to run tests locally using pytest?
- not sure why windows related ci failed... but glad to help if needed
- no, haven't tried unit test with pytest. Any clue about what to do w/ pytest for the task above in 1.?
I think the tests are failing for all OS in this PR. I can help you with debugging, but if you wanna try to see what is wrong you should run pytest locally, I've just updated the readme.
I think the tests are failing for all OS in this PR. I can help you with debugging, but if you wanna try to see what is wrong you should run pytest locally, I've just updated the readme.
sure let me take a look first
This needs to be redone on a recent master, if it's still worth doing.