Skip to content

Untrack stale docs/ tree; make README examples real - #8

Merged
thorwhalen merged 2 commits into
masterfrom
chore/untrack-docs-fix-readme
Oct 13, 2026
Merged

thorwhalen merged 2 commits into
masterfrom
chore/untrack-docs-fix-readme

Conversation

@thorwhalen

@thorwhalen thorwhalen commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Closes #4 (items 1 and 3 landed in #7).

  • git rm -r --cached docs: 66 generated Sphinx files were still tracked although .gitignore ignores docs/*. Pages is served from gh-pages (CI epythet job), so the site is unaffected.
  • README: its examples used py2store.QuickStore, FileCollection and FileBytesReader, none of which focal exports (a dangling reference once py2store left the dependencies). Rewritten on Files/TextFiles, which focal does export, and tests/test_readme.py runs them as doctests so they cannot rot again.

Adversarial review (fresh Opus): safe to land; nothing reads the tracked docs/ tree (Pages publishes docsrc build to gh-pages), README claims true, no Windows flakiness. One minor confirmed finding: the README key-validation example needs dol>=0.3.71 (the ".." escape fix) while pyproject declared bare dol; pinned in a follow-up commit on this PR.

🤖 Generated with Claude Code

thorwhalen and others added 2 commits October 13, 2026 16:10
…#4)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ape fix

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@thorwhalen
thorwhalen merged commit 17c62ea into master Oct 13, 2026
12 checks passed
@thorwhalen
thorwhalen deleted the chore/untrack-docs-fix-readme branch October 13, 2026 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cleanup: over-declared deps, 66 stale tracked docs/ files, dangling umpyre metrics config

1 participant