refactor: Use more explicit template debug messages

pawamoy · pawamoy · commit f2122d7fa119 · 2022-02-13T14:52:21.000+01:00
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html b/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering " + attribute.path) }}
 {% if config.show_if_no_docstring or attribute.has_docstrings %}
 
   <div class="doc doc-object doc-attribute">
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/children.html b/src/mkdocstrings_handlers/python/templates/material/_base/children.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering children of " + obj.path) }}
 {% if obj.members %}
 
   <div class="doc doc-children">
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/class.html b/src/mkdocstrings_handlers/python/templates/material/_base/class.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering " + class.path) }}
 {% if config.show_if_no_docstring or class.has_docstrings %}
 
   <div class="doc doc-object doc-class">
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering docstring") }}
 {% if docstring_sections %}
   {% for section in docstring_sections %}
     {% if section.kind.value == "text" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering admonition") }}
 <details class="{{ section.value.kind }}">
   <summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</summary>
   {{ section.value.contents|convert_markdown(heading_level, html_id) }}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering attributes section") }}
 {% if config.docstring_section_style == "table" %}
   <p><strong>{{ section.title or "Attributes:" }}</strong></p>
   <table>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering examples section") }}
 <p><strong>{{ section.title or "Examples:" }}</strong></p>
 {% for section_type, sub_section in section.value %}
   {% if section_type == "markdown" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering other parameters section") }}
 {% if config.docstring_section_style == "table" %}
   <p><strong>{{ section.title or "Other Parameters:" }}</strong></p>
   <table>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering parameters section") }}
 {% if config.docstring_section_style == "table" %}
   <p><strong>{{ section.title or "Parameters:" }}</strong></p>
   <table>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering raises section") }}
 {% if config.docstring_section_style == "table" %}
   <p><strong>{{ section.title or "Raises:" }}</strong></p>
   <table>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering receives section") }}
 {% if config.docstring_section_style == "table" %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or "Receives:" }}</strong></p>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering returns section") }}
 {% if config.docstring_section_style == "table" %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or "Returns:" }}</strong></p>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering warns section") }}
 {% if config.docstring_section_style == "table" %}
   <p><strong>{{ section.title or "Warns:" }}</strong></p>
   <table>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering yields section") }}
 {% if config.docstring_section_style == "table" %}
   {% set name_column = section.value|selectattr("name")|any %}
   <p><strong>{{ section.title or "Yields:" }}</strong></p>
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/function.html b/src/mkdocstrings_handlers/python/templates/material/_base/function.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering " + function.path) }}
 {% if config.show_if_no_docstring or function.has_docstrings %}
 
   <div class="doc doc-object doc-function">
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/module.html b/src/mkdocstrings_handlers/python/templates/material/_base/module.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering " + module.path) }}
 {% if config.show_if_no_docstring or module.has_docstrings %}
 
   <div class="doc doc-object doc-module">
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/signature.html b/src/mkdocstrings_handlers/python/templates/material/_base/signature.html
@@ -1,4 +1,4 @@
-{{ log.debug() }}
+{{ log.debug("Rendering signature of " + function.path) }}
 {%- if config.show_signature -%}
   {%- with -%}
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering " + attribute.path) }}`
`2`	`2`	`{% if config.show_if_no_docstring or attribute.has_docstrings %}`
`3`	`3`
`4`	`4`	`<div class="doc doc-object doc-attribute">`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering children of " + obj.path) }}`
`2`	`2`	`{% if obj.members %}`
`3`	`3`
`4`	`4`	`<div class="doc doc-children">`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering " + class.path) }}`
`2`	`2`	`{% if config.show_if_no_docstring or class.has_docstrings %}`
`3`	`3`
`4`	`4`	`<div class="doc doc-object doc-class">`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering docstring") }}`
`2`	`2`	`{% if docstring_sections %}`
`3`	`3`	`{% for section in docstring_sections %}`
`4`	`4`	`{% if section.kind.value == "text" %}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering admonition") }}`
`2`	`2`	`<details class="{{ section.value.kind }}">`
`3`	`3`	`<summary>{{ section.title\|convert_markdown(heading_level, html_id, strip_paragraph=True) }}</summary>`
`4`	`4`	`{{ section.value.contents\|convert_markdown(heading_level, html_id) }}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering attributes section") }}`
`2`	`2`	`{% if config.docstring_section_style == "table" %}`
`3`	`3`	`<p><strong>{{ section.title or "Attributes:" }}</strong></p>`
`4`	`4`	`<table>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering examples section") }}`
`2`	`2`	`<p><strong>{{ section.title or "Examples:" }}</strong></p>`
`3`	`3`	`{% for section_type, sub_section in section.value %}`
`4`	`4`	`{% if section_type == "markdown" %}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering other parameters section") }}`
`2`	`2`	`{% if config.docstring_section_style == "table" %}`
`3`	`3`	`<p><strong>{{ section.title or "Other Parameters:" }}</strong></p>`
`4`	`4`	`<table>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering parameters section") }}`
`2`	`2`	`{% if config.docstring_section_style == "table" %}`
`3`	`3`	`<p><strong>{{ section.title or "Parameters:" }}</strong></p>`
`4`	`4`	`<table>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ log.debug() }}`
	`1`	`+{{ log.debug("Rendering raises section") }}`
`2`	`2`	`{% if config.docstring_section_style == "table" %}`
`3`	`3`	`<p><strong>{{ section.title or "Raises:" }}</strong></p>`
`4`	`4`	`<table>`