docs: remove stale tox references left over from the uv migration - #283
Conversation
The migration to uv removed tox.ini, but both create_env_file.py docstrings still claimed "used in all tox environments except the linting environment". - postgresql_db/create_env_file.py: describe the real caller — it is run as a CI workflow step (`uv run python -m borm.db.postgresql_db.create_env_file` in unittests/coverage/integrationtests/python-publish) and documented in the README. - mysql_db/create_env_file.py: has no CI caller (the mysql backend is not wired into any workflow, unlike postgres). Reworded to describe manual/local invocation instead of claiming a caller it does not have. See PR comment for the open wire-up-vs-remove decision. Closes #278 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Open decision: what to do with the MySQL
|
There was a problem hiding this comment.
Pull request overview
This pull request removes outdated tox references from the module docstrings of the create_env_file.py helpers after the repository’s migration to uv, aligning the documentation with how these scripts are actually invoked.
Changes:
- Updated PostgreSQL
create_env_file.pydocstring to describe its CI workflow invocation (uv run python -m ...) and local usage documentation. - Updated MySQL
create_env_file.pydocstring to avoid claiming a CI caller and instead describe manual/local invocation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/borm/db/postgresql_db/create_env_file.py | Rewords docstring to replace stale tox wording with CI workflow + README-based usage. |
| src/borm/db/mysql_db/create_env_file.py | Rewords docstring to describe manual invocation and explicitly note lack of CI usage. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| """ | ||
| This python script copies the env.example to .env if .env does not already exists. | ||
| This is similar to the bash command `mv example.env .env`. | ||
| It is used in all tox environments except the linting environment. | ||
| It is run as a CI workflow step (``uv run python -m borm.db.postgresql_db.create_env_file`` in | ||
| unittests.yml, coverage.yml, integrationtests.yml and python-publish.yml) and documented for |
| """ | ||
| This python script copies the env.example to .env if .env does not already exists. | ||
| This is similar to the bash command `mv example.env .env`. | ||
| It is used in all tox environments except the linting environment. | ||
| Run it manually via ``uv run python -m borm.db.mysql_db.create_env_file`` for local MySQL setup; | ||
| unlike the PostgreSQL variant it is not currently invoked by any CI workflow. |
The script copies .env.example (a dotfile) to .env via copyfile, so the docstring should say ".env.example" and "cp .env.example .env" (not "env.example" / "mv example.env .env"); also "exists" -> "exist". Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
hf-krechan
left a comment
There was a problem hiding this comment.
Reviewed as part of the stale-tox-reference cleanup. Approved.
Comment/doc-only change with no behavioural effect. I verified the replacement text is actually correct rather than merely plausible:
- The new docstrings make specific factual claims and both hold up: the PostgreSQL variant is invoked in exactly
unittests.yml,coverage.yml,integrationtests.ymlandpython-publish.yml, and the MySQL variant is invoked by nothing in the repo — so "not currently invoked by any CI workflow" is accurate, not a guess. - CI is green.
What
Cleans up stale
toxreferences left over from the uv migration. Bothcreate_env_file.pymodule docstrings still claimed the script "is used in all tox environments except the linting environment", which is no longer true (there is notox.ini).Closes #278
Changes
src/borm/db/postgresql_db/create_env_file.py— reworded to describe the real caller: it runs as a CI workflow step (uv run python -m borm.db.postgresql_db.create_env_fileinunittests.yml,coverage.yml,integrationtests.yml,python-publish.yml) and is documented for local setup in the README.src/borm/db/mysql_db/create_env_file.py— this variant has no CI caller (the MySQL backend is not wired into any workflow, unlike PostgreSQL). Per the issue's requirement not to give it "a docstring claiming a caller it does not have", reworded it to describe manual/local invocation (it has a__main__block:uv run python -m borm.db.mysql_db.create_env_file).Open decision (see comment)
The issue offered "wire it up or delete it" for the MySQL variant. I did neither, because deletion looked wrong and wiring-up is a scope decision — details in the PR comment below.
Deliberately untouched
.tox/in.gitignoreand any historical records underdocs/**/plans|specs(per the sweep convention).🤖 Generated with Claude Code