main.py: Docstring

Author: adriendupuis

main.py

@@ -32,6 +32,7 @@ def define_env(env):
     @env.macro
     def include_file(filename, start_line=0, end_line=None, glue='', remove_indent=False):
         """
+        DEPRECATED: Use include_code instead.
         Include a file,
         optionally indicating start_line and end_line (start counting from 0)
         optionally set a glue string to lead every string except the first one (can be used for indent)
@@ -53,8 +54,16 @@ def include_file(filename, start_line=0, end_line=None, glue='', remove_indent=F
         return glue.join(line_range)
 
     @env.macro
-    def include_code(filename, start_line=1, end_line=None, indent_level=0, remove_indent=False):
-        return include_file(filename, start_line-1, end_line, '    ' * indent_level, remove_indent).rstrip()
+    def include_code(filepath, start_line=1, end_line=None, indent_level=0, remove_indent=False):
+        """
+        Include a file
+        filepath (string): The path to the file from project root
+        start_line (int): The line number to start including from (start counting from 1) - default is 1 (include first line)
+        end_line (int or None): The line number to end including to. If None, include until the end of the file - default is None (include end of file)
+        indent_level (int): The number of indent (4 spaces) to add to the beginning of each line - default is 0 (no indent added).
+        remove_indent (bool): Whether to remove absolute indent, the maximum of leading whitespaces without breaking relative indent - default is False (no indent removed)
+        """
+        return include_file(filepath, start_line-1, end_line, '    ' * indent_level, remove_indent).rstrip()
 
     @env.macro
     def cards(pages, columns=1, style="cards", force_version=False):