Skip to content

docs: align ticker latency wording with 10 ticks/sec default#207

Merged
NikolayS merged 1 commit into
mainfrom
docs/10hz-latency-wording
May 5, 2026
Merged

docs: align ticker latency wording with 10 ticks/sec default#207
NikolayS merged 1 commit into
mainfrom
docs/10hz-latency-wording

Conversation

@NikolayS
Copy link
Copy Markdown
Owner

@NikolayS NikolayS commented May 5, 2026

Summary

Updates remaining docs wording that still described the production ticker as pgque.ticker() every second or used legacy force_tick wording in the snapshot-rule path.

The docs now consistently distinguish:

  • default pg_cron path: one 1-second cron slot runs pgque.ticker_loop()
  • actual default tick cadence: tick_period_ms = 100 → 10 ticks/sec
  • external scheduler path: caller chooses how often to call pgque.ticker()
  • canonical manual helper: force_next_tick() (force_tick() remains alias)

Test

  • git diff --check
  • grep for stale phrases: up to 1s, up to one second, calls .*ticker.* every second, force_tick.*ticker.*receive

Docs-only change.

@NikolayS NikolayS changed the title docs: align ticker latency wording with 10hz default docs: align ticker latency wording with 10 ticks/sec default May 5, 2026
@NikolayS NikolayS merged commit 8dbe3d0 into main May 5, 2026
11 checks passed
@NikolayS NikolayS deleted the docs/10hz-latency-wording branch May 5, 2026 09:41
@NikolayS NikolayS mentioned this pull request May 7, 2026
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