From 40ae6c63d4ee8e9791f922260857c465f7d0109a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Denis=20Nut=CC=A6iu?= <denis.nutiu@gmail.com>
Date: Wed, 19 Apr 2017 16:03:14 +0300
Subject: [PATCH] Adding documentation to to_zero_count function

---
 src/resources/utilities.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/resources/utilities.py b/src/resources/utilities.py
index 59ab02d..a0b9026 100644
--- a/src/resources/utilities.py
+++ b/src/resources/utilities.py
@@ -18,6 +18,17 @@
 
 
 def to_zero_count(page_no):
+    """
+    Will subtract 1 from the argument it gets, converting it to an int.
+    If the conversion fails or the argument it's negatives it returns zero instead.
+
+    Args:
+        page_no: An integer
+
+    Returns:
+        It returns page_no - 1 if page_no can be safely converted to an integer else it returns zero.
+        If page_no is negative, it returns zero.
+    """
     try:
         page_no = int(page_no) - 1
         if page_no < 0: