Add/update/cleanup copyright headers in scimath#116
Conversation
This commits adds/updates/cleansup copyright headers in scimath. A large number of modules didnt have copyright headers. Some modules had copyright headers which were outdated or which had copyright headers in an old format. A smaller number had the original copyright of the author whose work was derived in some modules.
…date-copyright-headers
Codecov Report
@@ Coverage Diff @@
## master #116 +/- ##
==========================================
+ Coverage 67.35% 67.49% +0.13%
==========================================
Files 58 58
Lines 2757 2781 +24
Branches 358 358
==========================================
+ Hits 1857 1877 +20
- Misses 808 812 +4
Partials 92 92
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
LGTM
Looks like there are a few merge conflicts to address though.
You mention "Note that some of the module docstrings contained information about the attributes, functions or classes defined within - which has been removed in this PR." but it looks like in many cases these were kept here.
Also, once we run flake8 on CI we can add flake8_ets as a dependency to catch these. Note I have not yet run flake8 with flake8_ets installed locally, but that would probably be a good thing for me to do...
EDIT: I did and this was the result:
$ flake8 --select=H101
./scimath/units/substance.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/pressure.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/force.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/unit_parser.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/SI.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/temperature.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/energy.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/unit.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/area.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/units/power.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./scimath/interpolate/setup.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
./docs/source/conf.py:1:1: H101 Copyright header is missing, or doesn't match the expected wording.
These look like cases of having #!/usr/bin/env python before the copyright header
| # | ||
| # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| # Michael A.G. Aivazis | ||
| # California Institute of Technology |
…date-copyright-headers
these are unnecessary and these were interfering when running flake8_ets on the codebase modified: scimath/units/SI.py modified: scimath/units/area.py modified: scimath/units/energy.py modified: scimath/units/force.py modified: scimath/units/power.py modified: scimath/units/pressure.py modified: scimath/units/substance.py modified: scimath/units/temperature.py modified: scimath/units/unit.py modified: scimath/units/unit_parser.py
Thanks for catching those shebang-related flake8 ets errors @aaronayres35 . I've taken the liberty of removing them completely from the modules in question and I've fixed the merge conflicts. This PR is finally ready to go in. Thanks for the review. |
3 participants
This PR adds/updates/cleansup copyright headers in scimath.
A large number of modules didnt have copyright headers. Some modules had copyright headers which were outdated or which had copyright headers in an old format. A smaller number had the original copyright of the author whose work was derived in some modules.
Note that some of the module docstrings contained information about the attributes, functions or classes defined within - which has been removed in this PR. We intend to open a separate PR to re-add the information to the module docstrings - across all modules in the
scimath.unitssubpackage.