From 7b7dbb3ee296737f6e06bf42c8e71057e0833fff Mon Sep 17 00:00:00 2001
From: Vishnunarayan K I <appukuttancr@gmail.com>
Date: Fri, 22 Mar 2019 19:57:26 +0530
Subject: [PATCH] docs: some more docs

---
 anime_downloader/sites/helpers/request.py | 36 ++++++++++++++++++++++-
 docs/advanced/custom_site.rst             |  7 ++++-
 docs/api/{anime.rst => base_classes.rst}  |  0
 docs/api/helper_functions.rst             |  7 +++++
 docs/index.rst                            |  3 +-
 5 files changed, 50 insertions(+), 3 deletions(-)
 rename docs/api/{anime.rst => base_classes.rst} (100%)
 create mode 100644 docs/api/helper_functions.rst

diff --git a/anime_downloader/sites/helpers/request.py b/anime_downloader/sites/helpers/request.py
index 09e2021..8534895 100644
--- a/anime_downloader/sites/helpers/request.py
+++ b/anime_downloader/sites/helpers/request.py
@@ -34,6 +34,19 @@ def setup(func):
                    referer: str = None,
                    headers=None,
                    **kwargs):
+        '''
+        {0} performs a {0} request
+
+        Parameters
+        ----------
+        url : str
+            url is the url of the request to be performed
+        cf : bool
+            cf if True performs the request through cfscrape.
+            For cloudflare protected sites.
+        referer : str
+            a url sent as referer in request headers
+        '''
         sess = cf_session if cf else req_session
         if headers:
             default_headers.update(headers)
@@ -55,6 +68,7 @@ def setup(func):
         if logger.getEffectiveLevel() == logging.DEBUG:
             _log_response_body(res)
         return res
+    setup_func.__doc__ = setup_func.__doc__.format(func.__name__)
     return setup_func
 
 
@@ -66,6 +80,16 @@ def get(url: str,
         **kwargs):
     '''
     get performs a get request
+
+    Parameters
+    ----------
+    url : str
+        url is the url of the request to be performed
+    cf : bool
+        cf if True performs the request through cfscrape.
+        For cloudflare protected sites.
+    referer : str
+        a url sent as referer in request headers
     '''
 
 
@@ -76,7 +100,17 @@ def post(url: str,
          headers=None,
          **kwargs):
     '''
-    get performs a get request
+    post performs a post request
+
+    Parameters
+    ----------
+    url : str
+        url is the url of the request to be performed
+    cf : bool
+        cf if True performs the request through cfscrape.
+        For cloudflare protected sites.
+    referer : str
+        a url sent as referer in request headers
     '''
 
 
diff --git a/docs/advanced/custom_site.rst b/docs/advanced/custom_site.rst
index a056971..f2d6c13 100644
--- a/docs/advanced/custom_site.rst
+++ b/docs/advanced/custom_site.rst
@@ -8,4 +8,9 @@ Each of the site (in the tool) can roughly be classfied into two.
 - Sites which don't use cloudflare DDoS protection. Ex: :py:class:`~anime_downloader.sites.nineanime.NineAnime`
 - Sites which use cloudflare DDoS protection. Ex: :py:class:`~anime_downloader.sites.kissanime.KissAnime`
 
-Sites which use cloudflare have the base class :py:class:`~anime_downloader.sites.anime.BaseAnime`. Sites which don't have the base class :py:class:`~anime_downloader.sites.baseanimecf.BaseAnimeCF`.
+All sites have the base class :py:class:`~anime_downloader.sites.anime.Anime`.
+There are helper functions defined :py:func:`anime_downloader.sites.helpers.request.get` and :py:func:`anime_downloader.sites.helpers.request.post`.
+You are expected to use these functions to perform any network requests.
+There is also a helper function :py:func:`anime_downloader.sites.helpers.request.soupfiy` for making `BeautifulSoup` s out of requests.
+
+All requests are cached. So don't worry about making requests twice.
diff --git a/docs/api/anime.rst b/docs/api/base_classes.rst
similarity index 100%
rename from docs/api/anime.rst
rename to docs/api/base_classes.rst
diff --git a/docs/api/helper_functions.rst b/docs/api/helper_functions.rst
new file mode 100644
index 0000000..6b217db
--- /dev/null
+++ b/docs/api/helper_functions.rst
@@ -0,0 +1,7 @@
+Helper functions
+****************
+
+.. automodule:: anime_downloader.sites.helpers.request
+   :members:
+
+
diff --git a/docs/index.rst b/docs/index.rst
index e7bf4b4..8121ee8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -42,4 +42,5 @@ NOTE: To download from sites marked `[cloudflare]`, anime-downloader has to be i
    usage/watch
    usage/config
    advanced/custom_site
-   api/anime.rst
+   api/base_classes.rst
+   api/helper_functions.rst