Skip to content

docs: prune unearned comments and stale cross-references - #28

Merged
hmziqrs merged 1 commit into
freeoxide:masterfrom
hmziqagent:chore/comment-discipline-sweep
Oct 31, 2026
Merged

hmziqrs merged 1 commit into
freeoxide:masterfrom
hmziqagent:chore/comment-discipline-sweep

Conversation

@hmziqagent

Copy link
Copy Markdown
Contributor

Comment-discipline audit cleanup across the repo (30 files, +103/−288). No behavior changes except deleting two dead functions.

Rust crates

  • tests/edge_cases.rs: drop the 16-line mod doc (contained change narration), seven section-banner blocks, and inline play-by-play; intent already lives in the test names
  • main crate: trim 11 over-length docs on non-public items to the 3-line cap (client/persist.rs, bucket/shared.rs, mutation_bucket.rs, hook/fetch_retry.rs, mutation_hooks/internals.rs, use_infinite_query/fetch_runners.rs, core/error/sanitize.rs)
  • satellites: reclassify 8 private-item /// docs as // constraint notes (gpui-query-persist 6, gpui-query-http 2)

Web

  • src/lib/seo.ts: delete dead techArticle()/howTo() (no call sites) whose guard comment claimed docs live in a separate Docusaurus app (false; this repo is Starlight)
  • fix six comments pointing at files that no longer exist (vite.config.ts, src/routes/index.tsx, routes/__root.tsx, lib/blog.ts) in flags.ts, index.astro, 404.astro, BaseLayout.astro, blog.astro
  • strip "vanilla port of *.tsx" narration from 7 components + 2 BaseLayout blocks, keeping the real contracts
  • delete pure section banners in styles.css and the OG/markdown scripts; compress the starlight.css comment boxes to their invariants and drop the TODO(Phase 4)

Skills

  • gpui-query-extensions: the bootstrap example documented a hydrate cold-start step it never performed; the example now calls hydrate(...) per the API documented in the same file

Gates

  • cargo test --all-features: 795 passed, 0 failed
  • cargo clippy --all-features --all-targets -- -D warnings: clean
  • cargo doc --all-features --no-deps: zero warnings
  • bun run build in web/: 29 pages, all stages clean

gpui-query-legacy was audited too but left untouched (frozen per AGENTS.md).

Comment-discipline audit cleanup across the repo:
- tests/edge_cases.rs: drop mod doc with change narration, section
  banners, and inline play-by-play (intent lives in test names)
- main crate: trim eleven over-length docs on non-public items to the
  3-line cap
- satellites: reclassify private-item /// docs as // constraint notes
- web: delete dead techArticle/howTo schema helpers guarded by a false
  claim, six comments pointing at removed files, React-port narration
  headers, and pure section banners; compress starlight.css boxes to
  their invariants
- skills: make the extensions bootstrap example actually call hydrate
  instead of documenting a step it never performed
@hmziqrs
hmziqrs merged commit d68b675 into freeoxide:master Oct 31, 2026
5 checks passed
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.

2 participants