summaryrefslogtreecommitdiffstats
path: root/templates/txt.jinja2
diff options
context:
space:
mode:
Diffstat (limited to 'templates/txt.jinja2')
-rw-r--r--templates/txt.jinja238
1 files changed, 31 insertions, 7 deletions
diff --git a/templates/txt.jinja2 b/templates/txt.jinja2
index 5ca0c62..0d31047 100644
--- a/templates/txt.jinja2
+++ b/templates/txt.jinja2
@@ -69,17 +69,17 @@ Report generated at {{ get_datetime() }}
{%- if files_contents["documentation"]["comments"] == "None" %}
*** No comments present ***
{%- else %}
- ```
- {{ files_contents["documentation"]["comments"]|indent(8, False) }}
- ```
+ ```
+ {{ files_contents["documentation"]["comments"]|indent(16, False) }}
+ ```
{%- endif %}
Docstring:
{%- if files_contents["documentation"]["doc"] == "None" %}
*** No docstring present ***
{%- else %}
- ```
- {{ files_contents["documentation"]["doc"]|indent(8, False) }}
- ```
+ ```
+ {{ files_contents["documentation"]["doc"]|indent(16, False) }}
+ ```
{%- endif -%}
{%- endif %}
{%- if "classes" in files_contents.keys() %}
@@ -87,6 +87,27 @@ Report generated at {{ get_datetime() }}
{%- set flat_classes = flatten_struct(files_contents["classes"]) -%}
{% for class_name, class_contents in flat_classes.items() %}
{{ class_name + ":" }}
+ {%- if class_contents["present"] %}
+ Documentation:
+ {{ len_documentation(class_contents["documentation"]["comments"], class_contents["documentation"]["doc"]) }} characters long
+ {%- if txt_show_full_docs == "True" %}
+ Comments:
+ {%- if class_contents["documentation"]["comments"] == "None" %}
+ *** No comments present ***
+ {%- else %}
+ ```
+ {{ class_contents["documentation"]["comments"]|indent(16, False) }}
+ ```
+ {%- endif %}
+ Docstring:
+ {%- if class_contents["documentation"]["doc"] == "None" %}
+ *** No docstring present ***
+ {%- else %}
+ ```
+ {{ class_contents["documentation"]["doc"]|indent(16, False) }}
+ ```
+ {%- endif -%}
+ {%- endif %}
{%- if "methods" in class_contents.keys() %}
Methods:
{%- set flat_methods = flatten_struct(class_contents["methods"]) -%}
@@ -94,6 +115,9 @@ Report generated at {{ get_datetime() }}
{{ expand_function(method_name, method_contents, "Method")|indent(20, False) }}
{%- endfor -%}
{%- endif -%}
+ {%- else %}
+ *** Class not present ***
+ {%- endif -%}
{%- endfor -%}
{%- endif -%}
{% if "functions" in files_contents.keys() %}
@@ -140,5 +164,5 @@ Report generated at {{ get_datetime() }}
{% endfor %}
{% if out != "stdout" -%}
-{{ test_results["pytest_report"].replace("\n", "") }}
+{{ test_results["pytest_report"] }}
{%- endif -%} \ No newline at end of file