From 5f61b0ae76a979a10d272791ed343236ce30dfa6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aleksi=20H=C3=A4kli?= <aleksi.hakli@iki.fi>
Date: Tue, 26 Feb 2019 13:04:56 +0200
Subject: [PATCH] Improve documentation on axes.utils.reset
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
---
 docs/3_usage.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/3_usage.rst b/docs/3_usage.rst
index fec58d2..940861a 100644
--- a/docs/3_usage.rst
+++ b/docs/3_usage.rst
@@ -27,3 +27,8 @@ In your code, you can use the ``axes.utils.reset`` function.
 - ``reset()`` will reset all lockouts and access records.
 - ``reset(ip=ip)`` will clear lockouts and records for the given IP address.
 - ``reset(username=username)`` will clear lockouts and records for the given username.
+
+Please note that if you give both ``username`` and ``ip`` arguments to ``reset``
+that attempts that have both the set IP and username are reset.
+
+The effective behaviour of ``reset`` is to ``and`` the terms instead of ``or``ing them.