Skip to content

docs: simplify introductory custom Python Rule examples - #34

Merged
kvlonge merged 1 commit into
mainfrom
docs/concise-custom-rule
Nov 2, 2026
Merged

kvlonge merged 1 commit into
mainfrom
docs/concise-custom-rule

Conversation

@kvlonge

@kvlonge kvlonge commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Why

The introductory custom Rule should show a lightweight team convention without AST plumbing or assumptions about data-model layers.

Changes

  • Use the public statement.functions facts to report IFNULL calls, with COALESCE as the team convention.
  • Align the README, homepage, custom Rule overview, test snippet and generated documentation reference.
  • Keep findings source-located and report-only; no runtime, parser, version or performance changes.

Verification

  • 30 unit/integration tests and 4 skills-command tests pass; examples are loaded directly from all three documentation sources.
  • Real CLI runs in an isolated Python environment without Polyglot produce the documented orders.sql:1:8 finding. Safe and unsafe fix modes leave IFNULL unchanged; COALESCE passes.
  • Copied homepage pytest example passes.
  • Ruff, ty, fensu, generated-reference freshness, public hygiene and diff checks pass.
  • Website builds with 21 pages and zero broken links; homepage and docs renders inspected.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying sqlclean with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6b32471
Status: ✅  Deploy successful!
Preview URL: https://e46580b2.sqlclean.pages.dev
Branch Preview URL: https://docs-concise-custom-rule.sqlclean.pages.dev

View logs

@kvlonge
kvlonge merged commit 14f613c into main Nov 2, 2026
16 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.

1 participant