From 69f644c763a26abef3f6310ea8ea9cc610f05516 Mon Sep 17 00:00:00 2001
From: ronny abraham <ronny.abraham@ymail.com>
Date: Fri, 7 Jul 2023 19:12:26 +0300
Subject: [PATCH] added docs as a subdirectory

---
 .gitmodules       |  3 +++
 docs              |  1 +
 modules/django.py | 29 +++++++++++++++++------------
 3 files changed, 21 insertions(+), 12 deletions(-)
 create mode 100644 .gitmodules
 create mode 160000 docs

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..98401cd
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs"]
+	path = docs
+	url = git@bitbucket.org:ronnyabraham/fabric_docs.git
diff --git a/docs b/docs
new file mode 160000
index 0000000..697af1a
--- /dev/null
+++ b/docs
@@ -0,0 +1 @@
+Subproject commit 697af1a3153808dbffd87c415b9619ea59788696
diff --git a/modules/django.py b/modules/django.py
index 7767fcd..e03d8a3 100644
--- a/modules/django.py
+++ b/modules/django.py
@@ -50,6 +50,10 @@ def generate_secret_key():
 
 @task
 def test(args=None):
+    """
+    the purpose of this method is just to use as a placeholder for any kind of
+    testing of methods
+    """
     print("debug - testing checkapp(sorl.thumbnail): %s" %
           check_app("sorl.thumbnail"))
 
@@ -172,39 +176,40 @@ def coverage(application, args="test", workingdir=None, outputdir=None,
     Helper method that uses the coverage package
 
     :parameter application: the name of the installed application being tested.
-    NOTE: this is required because currently I do not know how to run manage.py
-    test on all installed applications.
+        NOTE: this is required because currently I do not know how to run
+        manage.py test on all installed applications.
     :type application: string
 
     :parameter args: the manage command that coverage is going to run.
-    defaults to test
+        defaults to test
     :type args: string
 
     :parameter workingdir: the working directory that manage will run it's
-    command under.  defaults to None
+        command under.  defaults to None
     :type workingdir: string
 
     :parameter outputdir: the directory to which file results will be
-    output to.  defaults to None
+        output to.  defaults to None
     :type outputdir: string
 
     :parameter coveragerc: flags whether or not there is a coverage settings
-    file which determines what coverage will or wont do.  coveragerc file is
-    located in share/coverage/setup.cfg you can modify this in the virtualenv
-    settings for this branch. defaults to True
+        file which determines what coverage will or wont do.  coveragerc file
+        is located in share/coverage/setup.cfg you can modify this in the
+        virtualenv settings for this branch. defaults to True
 
     :type coveragerc: boolean
 
     :parameter report: flags whether or not coverage will be asked to generate
-    a report.  defaults to true.
+        a report.  defaults to true.
     :type report: boolean
 
     :parameter html: flags whether or not coverage will generate an html
-    version of its report.  defaults to true
+        version of its report.  defaults to true
     :type html: boolean
 
-    TODO: test if coverage is installed and if it isn't give
-    an error explaining the problem
+    TODO:
+        test if coverage is installed and if it isn't give an error explaining
+        the problem
 
     TODO:
         currently, django.manage:test is not working properly because it does