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

Applying pylint to gempyor #500

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

Applying pylint to gempyor #500

wants to merge 6 commits into from

Conversation

emprzy
Copy link
Collaborator

@emprzy emprzy commented Feb 12, 2025

Describe your changes.

Adds a pylint linting GH action for gempyor. You can also spur the linting (along with black formatting) before PR by running ./bin/lint from the flepiMoP directory. Presently, the only adjustment this pylint implementation has is a max line length of 92 chr. In the future, we may look to:

  • add a --fail-under flag for failing under a certain score,
  • except certain error codes that we deem not helpful,
  • adjust pylint to only look at changed files?
  • anything else we decide...

Does this pull request make any user interface changes? If so please describe.

gempyor will now be linted with pylint through a GH action upon PR.

What does your pull request address? Tag relevant issues.

This pull request addresses GH- #398

@emprzy emprzy changed the title Gempyor pylint Applying pylint to gempyor Feb 12, 2025
@TimothyWillard TimothyWillard linked an issue Feb 13, 2025 that may be closed by this pull request
@TimothyWillard TimothyWillard added this to the Software Quality milestone Feb 13, 2025
@TimothyWillard TimothyWillard added enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. medium priority Medium priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. next release Marks a PR as a target to include in the next release. labels Feb 13, 2025
Copy link
Contributor

@TimothyWillard TimothyWillard left a comment

Choose a reason for hiding this comment

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

Looks good, a few minor comments. One thing that is missing is documentation, probably here is most appropriate: https://iddynamics.gitbook.io/flepimop/development/python-guidelines-for-developers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. medium priority Medium priority. meta/workflow Relating to CI / issue templates / testing frameworks / etc. next release Marks a PR as a target to include in the next release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature request]: Add pylint Or ruff Linting For gempyor
2 participants