From 3d3979fb0dbd5ba4cce3af81544cce7a80c17792 Mon Sep 17 00:00:00 2001
From: Chris Kuehl <ckuehl@yelp.com>
Date: Thu, 1 Nov 2018 09:59:28 -0700
Subject: [PATCH] Clarify ngx.timer.every callback argument conventions

---
 README.markdown | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.markdown b/README.markdown
index a6ecd677bd..2616bb722b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -7977,6 +7977,9 @@ Similar to the [ngx.timer.at](#ngxtimerat) API function, but
 1. `delay` *cannot* be zero,
 1. timer will be created every `delay` seconds until the current Nginx worker process starts exiting.
 
+Like [ngx.timer.at](#ngxtimerat), the `callback` argument will be called
+automatically with the arguments `premature`, `user_arg1`, `user_arg2`, etc.
+
 When success, returns a "conditional true" value (but not a `true`). Otherwise, returns a "conditional false" value and a string describing the error.
 
 This API also respect the [lua_max_pending_timers](#lua_max_pending_timers) and [lua_max_running_timers](#lua_max_running_timers).