feat: tooling upgrades, strict docstrings, and --version flag - #61
Merged
Conversation
- Update ruff-pre-commit to v0.15.4 - Update markdownlint-cli to v0.48.0
Updates contact_links URL to point to the correct jacksonfergusondev namespace.
- Update pyproject.toml to include ruff 'D' (pydocstyle) rules with Google convention. - Resolve resulting D205 formatting errors in cli.py and git_wrapper.py. - Enable verbose output and error context for mypy.
Implements standard argparse versioning using importlib.metadata to dynamically pull the package version from the installed wheel/sdist.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR updates project tooling configurations, enforces stricter documentation standards, and introduces a version output flag to the CLI.
Changes
pre-commithooks (ruffandmarkdownlint-cli) to their latest upstream versions.pyproject.tomlto enforce Google-style docstrings (ruffpydocstyle plugin) and configuredmypyto emit more verbose context. Fixed trailingD205docstring errors.--versionflag to the main parser. This dynamically resolves the package version usingimportlib.metadata, eliminating the need for hardcoded version strings..github/ISSUE_TEMPLATE/config.ymlpointing tojacksonfergusondev.Validation
uv run ruff check .(0 errors)mypygit pulsar --versionoutputs correct metadata