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

338 pre commit hooks #10

Merged
merged 8 commits into from
May 10, 2024
Merged

338 pre commit hooks #10

merged 8 commits into from
May 10, 2024

Conversation

Jday7879
Copy link
Collaborator

@Jday7879 Jday7879 commented May 9, 2024

Summary

Add your summary here - keep it brief, to the point, and in plain English.

Checklists

This pull request meets the following requirements:

  • installable with all dependencies recorded
  • runs without error
  • follows PEP8 and project specific conventions
  • appropriate use of comments, for example no descriptive comments
  • functions documented using Numpy style docstings
  • assumptions and decisions log considered and updated if appropriate
  • unit tests have been updated to cover essential functionality for a reasonable range of inputs and conditions
  • other forms of testing such as end-to-end and user-interface testing have been considered and updated as required
  • tests suite passes (locally as a minimum)
  • peer reviewed with review recorded

If you feel some of these conditions do not apply for this pull request, please
add a comment to explain why.

This branch has been created to perform the bulk changes required by the pre-commit hooks.
No functions have been added as a result of this branch.
One manual change to code has been made in flag_and _count_matched_pairs.py on L112

@Jday7879 Jday7879 requested a review from AntonZogk May 9, 2024 15:43
@Jday7879 Jday7879 marked this pull request as ready for review May 9, 2024 15:43
Copy link
Collaborator

@AntonZogk AntonZogk left a comment

Choose a reason for hiding this comment

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

All looking good with pre-commit hooks, was also able to install the requirements and the checks run after commit. Just 2 minor comments.

This pull request has changes to src/ and test/ files, had a closer look at them and all were related to code formatting from the hooks (removing whitespace, end liner etc)

The requirements.txt contains typically dependencies for user to install/run the source code while in this pull request it looks like that it has dependencies for developers and contributors, it is worth having this separately (in the toml or setup.cfg file), we can have though a separate ticket for this in the future.

@Jday7879
Copy link
Collaborator Author

Thanks @AntonZogk for the review.
I think we have a ticket on the backlog to separate out requirements into users and development (and probably docs).
I'll add your review comments onto that ticket for future reference as well

@Jday7879 Jday7879 merged commit 3a8b237 into main May 10, 2024
2 checks passed
@Jday7879 Jday7879 deleted the 338-pre-commit-hooks branch May 10, 2024 11:49
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.

2 participants