-
Notifications
You must be signed in to change notification settings - Fork 9
Draft: Add pre-commit hooks for Ruff and blacken-docs with global exclusions #195
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
Open
jeipollack
wants to merge
26
commits into
develop
Choose a base branch
from
feature/194/add-pre-commit-hooks
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ean up submodule docs, update conf.py, and update pyproject.toml version
- Removed old auto-generated wf_psf.rst from _autosummary - Updated toc.rst (fixed tab issues, reference api.rst) - Added api.rst with :recursive: directive and wf_psf.run entrypoint - Refined __init__.py docstrings for all subpackages for clarity and consistency - Updated module-level docstrings (purpose, authors, TensorFlow notes, etc.)
- Shorten sections to make developer-friendly - Added new structure for each section: Purppose, Key Fields, Notes, General Notes, etc, where applicable - Partial completion - new PR is required to verify optional versus required settings
- Added cross-references between config sections - Clarified required fields for ground_truth_model.model_params - Updated General Notes and reorganized section numbering - Improved examples and directory structures - Fixed build warnings due to missing anchors and code block lexing
- Add developer dir with subpage files: CoC, Git Workflow, Contributing files point to root-level docs - Add index.md with subpages
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces pre-commit hooks to enforce code quality and documentation formatting across the WaveDiff repository.
Closes #194
The configuration includes:
*.ipynb)papers/What’s Changed
.pre-commit-config.yamlupdated with hooks and global excludeHow to Test / Verify
pip install pre-commitpre-commit installpre-commit run --all-filespapers/or Jupyter notebooks are modified.py,.md,.rst,.yaml,.tomlfiles conform to the defined hooksScope
Reviewer Notes
.pre-commit-config.yamlmatches the project conventions and desired hooksNext Steps
pre-commit installCONTRIBUTING.mdabout pre-commit usage