pysat / pysatNASA

pysat support for NASA Instruments

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

21 stars 7 forks source link

STY: docstrings #150

Closed jklenzing closed 1 year ago

jklenzing commented 1 year ago

Description

Addresses #149

Moves properties to be the first item under each module docstring.

Type of change

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

How Has This Been Tested?

Inspection.

Test Configuration

Operating system: Mac OS X Monterrey
Version number: Python 3.10.8

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
[x] Update zenodo.json file for new code contributors