From 8df219e976b9c29f4cf9187d532c5622cf27aef0 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:35 +0200
Subject: [PATCH] Add public API documentation on the handler class
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>
---
 axes/handlers/base.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/axes/handlers/base.py b/axes/handlers/base.py
index ddc885f..275ab67 100644
--- a/axes/handlers/base.py
+++ b/axes/handlers/base.py
@@ -13,6 +13,17 @@ class AxesBaseHandler:  # pylint: disable=unused-argument
     """
     Handler API definition for subclassing handlers that can be used with the AxesProxyHandler.
 
+    Public API methods for this class are:
+
+    - is_allowed
+    - user_login_failed
+    - user_logged_in
+    - user_logged_out
+    - post_save_access_attempt
+    - post_delete_access_attempt
+
+    Other API methods are considered internal and do not have fixed signatures.
+
     If you wish to implement your own handler class just override the methods you wish to specialize
     and define the class to be used with ``settings.AXES_HANDLER = 'dotted.full.path.to.YourClass'``.
     """