ObanPowertools.Limits.Glossary (oban_powertools v0.5.1)

Copy Markdown View Source

Single-source rate-limit glossary for ObanPowertools limiters.

text/0 returns the canonical glossary markdown string consumed by both Mix task @moduledoc sections and guides/limits-and-explain.md.

Summary

Functions

text()

Returns the canonical rate-limit glossary as a markdown string.

Functions

text()

@spec text() :: String.t()

Returns the canonical rate-limit glossary as a markdown string.

This single string is the source of truth consumed by both Mix task @moduledoc sections (oban_powertools.limiter.explain and oban_powertools.limiter.simulate) and guides/limits-and-explain.md.