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

Fix pre-commit errors #80

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Fix pre-commit errors #80

merged 2 commits into from
Mar 22, 2024

Conversation

diazona
Copy link
Contributor

@diazona diazona commented Mar 21, 2024

A long line in this docstring was causing the flake8 pre-commit check to fail, so I edited the comment to be compliant. I shortened the lines to about 80 characters for consistency with other comments, even though that's more of a change than is strictly required to pass flake8. With this change, we can start requiring pre-commit to pass for all merges.

I also changed a note to use Restructured Text syntax, for compatibility with other docstrings in the project.

I also changed the pre-commit configuration to skip the actionlint hook, because it's not configured to run Docker hooks.

A long line in this docstring was causing the flake8 pre-commit check to
fail, so I edited the comment to be compliant. I shortened the lines to
about 80 characters for consistency with other comments, even though
that's more of a change than is strictly required to pass flake8. With
this change, we can start requiring pre-commit to pass for all merges.

I also changed a note to use Restructured Text syntax, for compatibility
with other docstrings in the project.
The actionlint hook uses Docker, which isn't configured in the runners
used by pre-commit.ci, so I'm marking that one to be skipped. In
the future we can set up some alternate way of running actionlint on
pull requests automatically.
@diazona diazona changed the title Modify a docstring to avoid exceeding line length limit Fix pre-commit errors Mar 21, 2024
@diazona diazona merged commit 200b5ce into master Mar 22, 2024
53 checks passed
@diazona diazona deleted the fix-pre-commit-error/1/dev branch March 22, 2024 02:57
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.

1 participant