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

[MNT] update pre-commit hook versions and make appropriate changes in the affected files #4676

Closed
yarnabrina opened this issue Jun 5, 2023 · 1 comment · Fixed by #4680
Closed
Labels
maintenance Continuous integration, unit testing & package distribution

Comments

@yarnabrina
Copy link
Collaborator

Most hook versions in .pre-commit-config.yaml is quite outdated. These may be updated to the latest verions using pre-commit autoupdate.

However, it leads to formatting changes (mostly by black) to ~140 files, as per pre-commit run --all-files. This will lead to change in Git blame for all of these. While that is useful to keep track of changes and ask for help/guidance in future by newer contributors, this may be worth considering in future.

Ref. #4673 (comment)

@yarnabrina yarnabrina added the maintenance Continuous integration, unit testing & package distribution label Jun 5, 2023
@fkiraly
Copy link
Collaborator

fkiraly commented Jun 5, 2023

I'd be fine with updating, if the changes are bunched in a single PR. The standard is blame by line anyway.

fkiraly pushed a commit that referenced this issue Jun 17, 2023
Closes #4676.

What this PR does:

1. Update hook versions.
2. Apply code formatting changes identified by `black`. (affected ~140
files)
3. Apply docstring length/style changes identified by
`flake8`+`pydocstyle`. (affected ~180 files)

Notes for reviewers:

* For the 3rd point above, used `docformatter` locally to automate few
docstring changes, and these are part of
d736b66.
* In few places where it was unable to solve the issues (mostly `D205`
and `D400`), used my own judgement to modify docstrings slightly to
avoid lint failures. These possibly biased changes are part of
ae526ad, and should be reviewed
carefully.
CTFallon pushed a commit to CTFallon/sktime that referenced this issue Jun 21, 2023
…me#4680)

Closes sktime#4676.

What this PR does:

1. Update hook versions.
2. Apply code formatting changes identified by `black`. (affected ~140
files)
3. Apply docstring length/style changes identified by
`flake8`+`pydocstyle`. (affected ~180 files)

Notes for reviewers:

* For the 3rd point above, used `docformatter` locally to automate few
docstring changes, and these are part of
d736b66.
* In few places where it was unable to solve the issues (mostly `D205`
and `D400`), used my own judgement to modify docstrings slightly to
avoid lint failures. These possibly biased changes are part of
ae526ad, and should be reviewed
carefully.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants