Skip to content

Commit

Permalink
doc: fixed typos in the docs for the uncommit() method.
Browse files Browse the repository at this point in the history
  • Loading branch information
agentzh committed Jul 14, 2016
1 parent 97b5c03 commit 749cc8a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions lib/resty/limit/conn.md
Expand Up @@ -278,8 +278,8 @@ uncommit
--------
**syntax:** `ok, err = obj:uncommit(key)`

This tries to undo the commit of the `incoming` call. This method is mainly for being used in the [resty.limit.conn](./conn.md)
Lua module.
This tries to undo the commit of the `incoming` call. This method is mainly for being used in the [resty.limit.traffic](./traffic.md)
Lua module when combining multiple limiters at the same time.

This method should not be used replace of the [leaving](#leaving) method though they are
similar in effect and implementation.
Expand All @@ -297,7 +297,7 @@ Out-of-Sync Counter Prevention
Under extreme conditions, like nginx worker processes crash in the middle of request processing,
the counters stored in the shm zones can go out of sync. This can lead to catastrophic
consequences like blindly rejecting *all* the incoming connections for ever. (Note that
the standard ngx_limit_conn module also suffers from this issue.) We may
the standard `ngx_limit_conn` module also suffers from this issue.) We may
add automatic protection for such cases to this Lua module in the near future.

Also, it is very important to ensure that the `leaving` call appears first in your
Expand Down
4 changes: 2 additions & 2 deletions lib/resty/limit/req.md
Expand Up @@ -196,8 +196,8 @@ uncommit
**syntax:** `ok, err = obj:uncommit(key)`

This tries to undo the commit of the `incoming` call. This is simply an approximation
and should be used with care. This method is mainly for being used in the [resty.limit.conn](./conn.md)
Lua module.
and should be used with care. This method is mainly for being used in the [resty.limit.traffic](./traffic.md)
Lua module when combining multiple limiters at the same time.

[Back to TOC](#table-of-contents)

Expand Down

0 comments on commit 749cc8a

Please sign in to comment.