Update documentation to refer to poe #61
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project’s documentation to use a single poe check command for running tests, linting, formatting, and typing checks instead of separate uv run commands.
- README.md: Replaced individual
uv runcommands withuv run poe checkand adjusted phrasing around pre-commit usage. - .junie/guidelines.md: Consolidated testing, linting, formatting, and typing instructions into one
uv run poe checkcommand and removed outdated sections.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Swapped multiple uv run calls for uv run poe check and tweaked phrasing. |
| .junie/guidelines.md | Combined several check commands into a single poe check invocation and pruned deprecated guidance. |
Comments suppressed due to low confidence (2)
README.md:96
- [nitpick] Consider updating the phrasing to 'or to use pre-commit:' for parallel structure with the preceding 'To run them all using…'.
or using pre-commit:
.junie/guidelines.md:14
- [nitpick] Since the command now covers tests, formatting, linting, and typing, consider renaming this header to 'Running Checks' to better reflect its scope.
### Running Tests
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.
No description provided.