Fix incorrect docstring in automate.py regarding date_ranges

spencerahill / aospy

Python package for automated analysis and management of gridded climate data

Apache License 2.0

83 stars 12 forks source link

Fix incorrect docstring in automate.py regarding date_ranges #298

Closed jdossgollin closed 5 years ago

jdossgollin commented 5 years ago

As comment suggested, this fixes a documentation bug pointed out in #295

jdossgollin commented 5 years ago

@spencerkclark Do I need @pytest.mark.xfail here as suggested here?

spencerkclark commented 5 years ago

Do I need @pytest.mark.xfail here as suggested here?

Thanks @jdossgollin, we just need that in one PR -- it could be this one; it could your other one. Once that fix is merged the Appveyor and Travis checks will succeed. Stickler-CI checks for formatting issues; in this case it found a couple lines that are too long by PEP8 standards. If you shorten each of them a bit, that check will succeed too.

spencerahill commented 5 years ago

@jdossgollin thanks for this. A couple tips for PRs:

It's helpful to make the PR name a bit more descriptive. I've renamed this one as such.
It's helpful to have the initial PR message start with "Closes ###", where "###" is the Issue number that the PR is meant to address. Then Github will automatically close the Issue once the PR gets merged.