fixed tabbing for doc strings

src/content.py

@@ -21,11 +21,11 @@ locale.setlocale(locale.LC_TIME, LOCAL)
 
 def gen_arch_string():
   """
-    Creates and returns a archive string of every file in ENTRY_DIR.
+  Creates and returns a archive string of every file in ENTRY_DIR.
 
-    Returns:
+  Returns:
-    string: html-formatted archive-string
+  string: html-formatted archive-string
-    """
+  """
   path_ex = ENTRY_DIR
   if path.exists(path_ex):
     name_list = os.listdir(path_ex)
@@ -60,11 +60,11 @@ def gen_arch_string():
 
 def gen_index_string():
   """
-    Create and returns a string including every file in the ENTRY_DIR as an index.
+  Create and returns a string including every file in the ENTRY_DIR as an index.
 
-    Returns:
+  Returns:
-    string: html-formatted index string
+  string: html-formatted index string
-    """
+  """
   path_ex = ENTRY_DIR
   content_string = ""
   if path.exists(path_ex):
@@ -121,16 +121,16 @@ def absolutize_html(string):
 
 def gen_stand_string(path_ex):
   """
-    Creates a html-string for a file.
+  Creates a html-string for a file.
-    If the file is markdown it will convert it.
+  If the file is markdown it will convert it.
-    This functions ensures upscaling for future formats.
+  This functions ensures upscaling for future formats.
 
-    Parameters:
+  Parameters:
-    path_ex: path to a file.
+  path_ex: path to a file.
 
-    Returns:
+  Returns:
-    string: html-formatted string string equivalent to the file
+  string: html-formatted string string equivalent to the file
-    """
+  """
   filename = os.path.join(ENTRY_DIR, path_ex)
   content_string = ""
   if path.exists(filename):
@@ -154,15 +154,15 @@ def gen_stand_string(path_ex):
 
 def gen_md_content(path_ex, depth):
   """
-    Convert a markdown file to a html string.
+  Convert a markdown file to a html string.
 
-    Parameters:
+  Parameters:
-    path_ex (string): path to the markdown file
+  path_ex (string): path to the markdown file
-    depth (int): starting depth for markdown headings
+  depth (int): starting depth for markdown headings
 
-    Returns:
+  Returns:
-    string: html-formatted string string equivalent to the markdown file
+  string: html-formatted string string equivalent to the markdown file
-    """
+  """
   content_string = ""
   if path.exists(path_ex):
     header = "#"
@@ -179,11 +179,11 @@ def gen_md_content(path_ex, depth):
 
 def get_rss_string():
   """
-    Create a rss-string of the blog and return it.
+  Create a rss-string of the blog and return it.
 
-    Returns:
+  Returns:
-    string: rss-string of everything that is in the ENTRY_DIR.
+  string: rss-string of everything that is in the ENTRY_DIR.
-    """
+  """
   locale.setlocale(locale.LC_TIME, "en_US.UTF-8")
   path_ex = ENTRY_DIR
   content_string = ""
@@ -218,14 +218,14 @@ def get_rss_string():
 
 def gen_query_res_string(query_str):
   """
-    Return the results of a query.
+  Return the results of a query.
 
-    Parameters:
+  Parameters:
-    query_str (string): term to search
+  query_str (string): term to search
 
-    Returns:
+  Returns:
-    string: html-formated search result
+  string: html-formated search result
-    """
+  """
   src_results = search.search(query_str)
   res_string = ""
   for result in src_results:
@@ -251,14 +251,14 @@ def gen_query_res_string(query_str):
 
 def create_preview(path, is_markdown):
   """
-    Create a preview of a given article and return it.
+  Create a preview of a given article and return it.
 
-    Parameters:
+  Parameters:
-    path (string): path to the article
+  path (string): path to the article
 
-    Returns:
+  Returns:
-    string: html-formated preview
+  string: html-formated preview
-    """
+  """
   file = open(path, "r", encoding="utf-8")
   lines = file.read()
   if is_markdown:

src/search.py

@@ -14,11 +14,10 @@ ENTRY_DIR = config.ENTRY_DIR
 
 def createSearchableData(root):
   """
-
+  Schema definition: title(name of file), path(as ID), content(indexed but not stored), textdata (stored text content)
-    Schema definition: title(name of file), path(as ID), content(indexed but not stored), textdata (stored text content)
+  source:
-    source:
+  https://appliedmachinelearning.blog/2018/07/31/developing-a-fast-indexing-and-full-text-search-engine-with-whoosh-a-pure-pythhon-library/
-    https://appliedmachinelearning.blog/2018/07/31/developing-a-fast-indexing-and-full-text-search-engine-with-whoosh-a-pure-pythhon-library/
+  """
-    """
   schema = Schema(title=TEXT(stored=True), path=ID(stored=True), content=TEXT)
   if not os.path.exists(INDEX_DIR):
     os.mkdir(INDEX_DIR)
@@ -37,15 +36,15 @@ def createSearchableData(root):
 
 def search_times(query_str, topN):
   """
-    Search for a given term and returns a specific amount of results.
+  Search for a given term and returns a specific amount of results.
 
-    Parameters:
+  Parameters:
-    query_str (string): term to search for
+  query_str (string): term to search for
-    topN (int): number of results to return
+  topN (int): number of results to return
 
-    Returns:
+  Returns:
-    string: html-formatted string including the hits of the search
+  string: html-formatted string including the hits of the search
-    """
+  """
   ix = open_dir(INDEX_DIR)
   results = []
   with ix.searcher(weighting=scoring.BM25F) as s:
@@ -58,14 +57,14 @@ def search_times(query_str, topN):
 
 def search(query_str):
   """
-    Search for a given term and show the predefined amount of results.
+  Search for a given term and show the predefined amount of results.
 
-    Parameters:
+  Parameters:
-    query_str (string): term to search for
+  query_str (string): term to search for
 
-    Returns:
+  Returns:
-    string: html-formatted string including the hits of the search
+  string: html-formatted string including the hits of the search
-    """
+  """
   return search_times(query_str, DEF_TOPN)