Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: Address Pylint issues #28

Merged
merged 1 commit into from
Feb 28, 2024
Merged

MAINT: Address Pylint issues #28

merged 1 commit into from
Feb 28, 2024

Conversation

carlwilson
Copy link
Member

  • no functional changes;
  • used of f'' string rather than str.format();
  • better used of constants for strings, though not perfect;
  • better code documentation, though far from perfect;
  • test adjustments to match, though no pylint on test code;
  • use of generation expressions rather than list comprehensions; and
  • various occurrences of minor issues:
    • unused variables/parameters/imports;
    • overlong lines; and
    • redundant braces and else statements.

- no functional changes;
- used of `f''` string rather than `str.format()`;
- better used of constants for strings, though not perfect;
- better code documentation, though far from perfect;
- test adjustments to match, though no pylint on test code;
- use of generation expressions rather than list comprehensions; and
- various occurrences of minor issues:
  - unused variables/parameters/imports;
  - overlong lines; and
  - redundant braces and else statements.
@carlwilson carlwilson added the enhancement New feature or request label Feb 28, 2024
@carlwilson carlwilson self-assigned this Feb 28, 2024
Copy link
Collaborator

@darrendignam darrendignam left a comment

Choose a reason for hiding this comment

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

The changes are welcomed, settings a more consistent style going forward.

The only quibble I would have is the declaration of constants throughout the project.
One I see at least twice now is:
METS: str = 'METS.xml'

If we have string constants appearing in multiple modules, perhaps we should consider using a 'constants.py' module to declare these strings in one location.

@carlwilson
Copy link
Member Author

The only quibble I would have is the declaration of constants throughout the project. One I see at least twice now is: METS: str = 'METS.xml'

My intention is to gather these up once factored out. Next pass...

@carlwilson carlwilson merged commit a392cb1 into integration Feb 28, 2024
4 checks passed
@carlwilson carlwilson deleted the maint/pylint branch February 28, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants