Closed josiahdavis closed 3 years ago
@verdimrc I'd like to get your feedback on the approach here for a GH Actions + tox based workflow. Not quite ready to merge it yet, might make 1-2 minor changes to the tox.ini file, just looking for a second set of eyes on it.
Minor comments on tox.ini
:
[pytest]
, remove --ignore=test/s3fscompat
(this was for another test that doesn't exist in this repo).pydocstyle
: is the plan to enable this step in the actions? In my experience, its default setting might feel a bit too stringent to some, esp. for a stylistic / documentation aspect rather than for code correctness.To remove [testenv:reformat]
in tox.ini
, as this won't be used in the actions.
Suggest a [testenv:isort-check]
.
To remove
[testenv:reformat]
intox.ini
, as this won't be used in the actions.
Do you think it might be useful to keep it in there as a handy utility for folks who want to use it locally though?
To remove
[testenv:reformat]
intox.ini
, as this won't be used in the actions.Do you think it might be useful to keep it in there as a handy utility for folks who want to use it locally though?
pre-commit handles this case. (and fyi, that reformat entry predates precommit, so in a way it's a remnant from the past).
I see some benefits for those who want to use it, so maybe put some commentaries is a good middle ground?
Minor comments on
tox.ini
:
- under
[pytest]
, remove--ignore=test/s3fscompat
(this was for another test that doesn't exist in this repo).
Yes, I should have removed this one.
pydocstyle
: is the plan to enable this step in the actions? In my experience, its default setting might feel a bit too stringent to some, esp. for a stylistic / documentation aspect rather than for code correctness.
Agreed it does feel too stringent, and I was not planning to put it into the CI. That said, on the fence about whether to leave it in their as on optional check or no.
Issue #, if available: NA
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.