Skip to content

docs: evidence-backed functional verification of every documented command #265

@NikolayS

Description

@NikolayS

Goal

Reach 100% confidence that every command in docs/*.md works exactly as documented — backed by captured evidence, not assertions.

A prior single-agent pass reported "all verified," but its log was a summary, not raw transcripts. This issue tracks independent verification runs that each install sql/pgque.sql on a live Postgres + pg_cron, execute every documented snippet, and post the actual command + actual output as a comment here.

Scope (every runnable command)

  • docs/tutorial.md — full walkthrough (create_queue/subscribe/send → tick → receive/ack → nack/retry → DLQ → status/get_consumer_info → start() → teardown)
  • docs/installation.md — install, pgque.start() schedules + auto-delivers, manual ticker/maint, role-grant matrix, upgrade, uninstall
  • docs/examples.md — fan-out, exactly-once, batch send, recurring cron, DLQ replay
  • docs/monitoring.md — status/get_*_info columns, stuck-consumer query
  • docs/reference.md — every function/overload exists with documented signature/return/grant
  • docs/latency-and-tuning.md, docs/concepts.md — runnable bits

Method

  • Independent runs across supported majors (PG 14, 16, 18), each its own container + pg_cron.
  • For each documented command: paste the verbatim command and the verbatim output; mark PASS or DISCREPANCY (judge semantic correctness — ids/timestamps/latencies will differ).
  • Any real discrepancy → a fix PR linked here.

Known not-auto-testable (note, don't fail on)

  • pg_tle packaging path (needs pg_tle in the image / source build)
  • Python/Go/TypeScript client code snippets

Verification comments to follow from independent runs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions