docs: correct the CI trigger description and state the supported Python range - #38
Merged
Merged
Conversation
…on range The Development section claimed test.yml runs "on every push and pull request". The workflow is triggered by `push: branches: [main]` and `pull_request`, so a push to a feature branch with no open PR is not covered -- worth saying plainly, since that is exactly the case where a contributor is likely to assume CI has their back. The same sentence also undersold the workflow: it runs a compile check and an import smoke test before pytest, across a 3.9-3.13 matrix. The supported interpreter range was documented nowhere in the README even though pyproject.toml pins `requires-python = ">=3.9"`, so it is now stated next to the dependency list. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Self-review finding: the new line repeated test.yml's rationale for stopping at 3.13 (pygame's prebuilt wheel range), creating a second place that goes stale the moment pygame ships a cp314 wheel. The README states the tested range and defers the reason to the workflow that encodes it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Member
Author
Self-review rubricScored against the diff and command output rather than judgment. Items with no surface in this PR are marked N/A with the reason.
Summary: one finding, fixed in-branch; one acknowledged gap left tracked in #39 because the file it lives in is out of autonomous scope. This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
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
A documentation accuracy sweep was run across
README.md,RELEASING.md,pyproject.toml, the workflow files and thegraphik.pydocstrings, with every claim checked against the source it describes. One inaccuracy and one omission were found, both in the README, and both are corrected here..github/workflows/test.ymlruns "on every push and pull request". The workflow is triggered bypush: branches: [main]andpull_request, so a push to a feature branch with no open pull request is not covered. That gap is now stated plainly, since it is precisely the situation in which a contributor is most likely to assume CI has already run.pytest, across the full support matrix, none of which was mentioned.pyproject.tomlpinsrequires-python = ">=3.9"and the matrix covers 3.9 through 3.13, but neither figure appeared in the README. Both are now stated next to the dependency list.No code, test, packaging or workflow file is touched — the change is confined to
README.md.Deferred this cycle
vprefix) was left untouched. It is gated on a maintainer decision between two release-process directions, and it touches.github/workflows/and the release procedure, both of which are excluded from autonomous change..github/workflows/test.ymlcarries the same "every push and pull request" overstatement corrected here. It was left alone because workflow files are excluded from autonomous change; a separate issue has been filed so the two do not stay out of step.Test plan
python3 -m py_compile src/main/python/preponderous/graphik/graphik.py— passespython3 -c "import preponderous.graphik"import smoke test — passes, reports0.3.0.dev20260808python3 -m pytest -q(headless viaconftest.py) — 37 passed.github/workflows/test.ymlandpyproject.tomlrather than from memoryNo tracking issue — the drift was found during a documentation accuracy sweep.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson