refactor(vocabulary): the retired engine's name reaches zero outside docs/adr (47 -> 0) - #368
Open
ywatanabe1989 wants to merge 1 commit into
Open
refactor(vocabulary): the retired engine's name reaches zero outside docs/adr (47 -> 0)#368ywatanabe1989 wants to merge 1 commit into
ywatanabe1989 wants to merge 1 commit into
Conversation
…docs/adr (47 -> 0)
Operator ruling 2026-08-31: the retired storage engine is irrelevant to us;
its name is permitted only under docs/adr, and the guard tests for it are not
wanted either.
src/ was measured FIRST and is clean (zero hits), so this is a docs/tests/
examples vocabulary pass only - no live code was touched.
DELETED (subject is the retired engine itself):
- .scitex/clew/runtime/db.sqlite - a 69 KB binary database committed into
the repo; the artifact of the retired engine, not source.
- examples/_legacy/scitex/db/_sqlite3/ - 12 example stubs, every one of them
zero bytes. Their names carried the word; their contents carried nothing.
- examples/_legacy/notebooks/19_scitex_db.ipynb - a legacy tutorial whose
subject is the retired engine's API (19 of the repo's hits lived here).
The index entry pointing at it was removed with it, so no link dangles.
REWORDED (real history and live documentation, kept readable and true):
- README.md, docs/05_ADDITIONAL_MODULES.md - the scitex.db section now
documents the PostgreSQL client. stx.db.PostgreSQL(dbname=...) is the real
verified signature, so the example still runs.
- docs/sphinx/core_concepts.rst, docs/sphinx/modules/io.rst - clew provenance
now reads "a local database"; the mechanism described is unchanged.
- docs/guides/CROSSREF_API_CONFIGURATION.md - "single-file local database".
- .env.d.examples, pyproject.toml comment, two .gitignore files, the legacy
io guideline table and the schematic example's figure label.
TESTS - nothing was weakened, skipped or xfailed:
- test_cross_package_imports.py: dropped "scitex_io._load_modules._sqlite3".
That module no longer exists (find_spec -> None), so the auto-generated
snapshot entry was permanently skipping. Removing a dead entry costs no
coverage.
- test_integration.py: test_db_delegates keeps its subject - delegation to
scitex-db is still proven by the PostgreSQL and check_health asserts; only
the retired engine's probe is gone.
- scripts/maintenance/_pypi_packages.py: the stdlib-inventory entry is
provably dead here - sync_pyproject_extras.py scans <repo>/src, and src/
has zero references, so it can never be consulted.
VERIFICATION, with positive controls (an empty grep from a broken pattern
looks exactly like a real absence, so the search was proved to run):
- after, working tree, outside docs/adr : ZERO (exit 1)
- after, staged index, outside docs/adr: ZERO (exit 1)
- after, whole tree INCLUDING docs/adr : ZERO
- CONTROL: the same pattern and pathspec against origin/develop still finds
18 files - the search is not broken.
- CONTROL: the same live-tree search for "postgres" finds 6 files - the
working-tree search really runs.
- tracked filenames containing the word: ZERO.
Note: this repo's docs/adr holds a single ADR (0001-relocate-media-to-
scitex-etc.md) that never mentions the engine, so the usual
"docs/adr must still show hits" control is not available here and the two
controls above stand in its place.
Collected the integration suite: 315 collected, 0 collection errors; the two
edited files ran 181 passed, 52 skipped, 1 xfailed, 0 failed.
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.
Ruling
Operator, 2026-08-31:
Scope
src/was measured first and is clean - zero hits. This is therefore a docs / tests / examples vocabulary pass only; no live code was touched.docs/adrDeleted - subject is the retired engine itself
.scitex/clew/runtime/db.sqlite- a 69 KB binary database committed into the repo. An artifact of the retired engine, not source.examples/_legacy/scitex/db/_sqlite3/- 12 example stubs, every one of them zero bytes. Their names carried the word; their contents carried nothing.examples/_legacy/notebooks/19_scitex_db.ipynb- a legacy tutorial whose subject is the retired engine's API (19 of the 47 hits lived here). The master-index entry pointing at it was removed with it, so no link dangles.Reworded - real history and live docs, kept readable and true
README.md,docs/05_ADDITIONAL_MODULES.md- thescitex.dbsection now documents the PostgreSQL client.stx.db.PostgreSQL(dbname=...)is the real signature, verified against the installed package, so the example still runs.docs/sphinx/core_concepts.rst,docs/sphinx/modules/io.rst- clew provenance now reads "a local database". The mechanism described is unchanged.docs/guides/CROSSREF_API_CONFIGURATION.md- "single-file local database with indexed fields"..env.d.examples/, apyproject.tomlcomment, two.gitignorefiles, the legacy io guideline table, and the schematic example's figure label.Tests - nothing weakened, skipped or xfailed
test_cross_package_imports.py- dropped"scitex_io._load_modules._sqlite3". That module no longer exists (find_spec->None), so this auto-generated snapshot entry was permanently hitting the file's ownpytest.skippath. Removing a dead entry costs no coverage.test_integration.py-test_db_delegateskeeps its stated subject. Delegation toscitex-dbis still proven by thePostgreSQLandcheck_healthasserts; only the retired engine's probe is gone.scripts/maintenance/_pypi_packages.py- the stdlib-inventory entry is provably dead here:sync_pyproject_extras.pyscans<repo>/src, andsrc/has zero references, so the entry can never be consulted.Verification, with positive controls
An empty grep from a broken pattern looks identical to a real absence, so the search itself was proved to run.
docs/adrdocs/adrdocs/adrorigin/developpostgresSuite: 315 collected in the integration tests, 0 collection errors. The two edited files run 181 passed, 52 skipped, 1 xfailed, 0 failed.