pysat / pysatSeasons

Seasonal Analysis routines for pysat

BSD 3-Clause "New" or "Revised" License

3 stars 1 forks source link

STY/TST: Update code and docstring style, include in CI tests #32

Closed jklenzing closed 2 years ago

jklenzing commented 2 years ago

Description

Adds flake8-dcostrings and hacking to CI environments for improved style checks.

Updates style accordingly:

Missing docstrings
docstring format
import order

Type of change

Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

flake8 . --count --select=D,E,F,H,W --show-source --statistics

Test Configuration:

Operating system: Mac OS X 11.6.5
Version number: python 3.8.11
Any details about your local setup that are relevant
- hacking
- flake8-docstrings

Checklist:

[x] Make sure you are merging into the develop (not main) branch
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
[x] Add a note to CHANGELOG.md, summarizing the changes

rstoneback commented 2 years ago

Thanks @jklenzing!