Skip to content

General cleanup - #355

Merged
achilleas-k merged 36 commits into
G-Node:masterfrom
mpsonntag:cleanup
Feb 12, 2020
Merged

achilleas-k merged 36 commits into
G-Node:masterfrom
mpsonntag:cleanup

Conversation

@mpsonntag

Copy link
Copy Markdown
Contributor

This PR tries to cleanup all minor PEP8 issues in one go. It addresses only issues that do not change any behaviour. From my point of view any future PRs addressing code quality will be easier to review and discuss if they are not mixed with additional minor PEP8 issues.

The PR further tries to now provide full documentation for all relevant classes and functions.

The PR also updates the CI builds to include Python 3.8 on all OS and adds an allowed to fail build for Python 3.9dev on Travis.

- wrong-import-order
- invalid-name
- built-in shadowing
- invalid-name
- trailing-whitespaces
- line-too-long
- bad-continuation
- invalid-name
- wrong-import-order
- bad-continuation
- consider-merging-isinstance
- fixme
- invalid-name
- redefined-builtin
- invalid-name
- redefined-builtin
- wrong-import-order
- invalid-name
- invalid-name
- line-too-long
- redefined-builtin
- pointless-string-statement
- invalid-name
- line-too-long
- bad-continuation
- invalid-name
- consider-merging-isinstance
- consider-merging-isinstance
- no-else-return
- invalid-name
- redefined-builtin (format)
- fixme
- invalid-name
- Added travis osx python 3.8 build
- Added travis python 3.9dev build with allowed fail
- Added appveyor python 3.8 builds
- fixme
- invalid-name
- line-too-long
- trailing-whitespace
@coveralls

coveralls commented Feb 11, 2020 •

Copy link
Copy Markdown

Coverage Status

Coverage decreased (-0.3%) to 75.133% when pulling fb84454 on mpsonntag:cleanup into a8941de on G-Node:master.

- anomalous-backslash-in-string
- fixme
- invalid-name
- line-too-long
- trailing-whitespace

@achilleas-k achilleas-k left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful PR. A joy to read.

Approving with a bunch of recommended changes for docstring grammar, because when everything else is fine, all that's left is nitpicking grammar.

All the recommendations are for grammatical consistency of docstrings. Most method and property docstrings were consistent in that method docstrings describe an action (e.g., "Checks an input string...") and property docstrings describe the value they return ("The name of the Section"). The changes were for docstrings that don't follow that rule.

Comment thread odml/base.py Resolved
Comment thread odml/base.py Resolved
Comment thread odml/dtypes.py Resolved
Comment thread odml/dtypes.py Resolved
Comment thread odml/dtypes.py Resolved
Comment thread odml/validation.py Resolved
Comment thread odml/validation.py Resolved
Comment thread odml/validation.py Resolved
Comment thread odml/validation.py Resolved
Comment thread odml/validation.py Resolved

@achilleas-k achilleas-k left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful PR. A joy to read.

Approving with a bunch of recommended changes for docstring grammar, because when everything else is fine, all that's left is nitpicking grammar.

All the recommendations are for grammatical consistency of docstrings. Most method and property docstrings were consistent in that method docstrings describe an action (e.g., "Checks an input string...") and property docstrings describe the value they return ("The name of the Section"). The changes were for docstrings that don't follow that rule.

Co-Authored-By: Achilleas Koutsou <achilleas.k@gmail.com>
@achilleas-k
achilleas-k merged commit 92e5781 into G-Node:master Feb 12, 2020
@mpsonntag
mpsonntag deleted the cleanup branch February 12, 2020 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants