8000 refactor: Wrap docstring section elements (list style) in code tags t… · Viicos/python@1ae8dd8 · GitHub
[go: up one dir, main page]

Skip to content

Commit 1ae8dd8

Browse files
committed
refactor: Wrap docstring section elements (list style) in code tags to prevent spell checker errors
1 parent 47b4115 commit 1ae8dd8
10000

File tree

15 files changed

+15
-15
lines changed

15 files changed

+15
-15
lines changed

src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<ul>
4141
{% for attribute in section.value %}
4242
<li class="field-body">
43-
<b>{{ attribute.name }}</b>
43+
<b><code>{{ attribute.name }}</code></b>
4444
{% if attribute.annotation %}
4545
{% with expression = attribute.annotation %}
4646
(<code>{% include "expression.html" with context %}</code>)

src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<ul>
3333
{% for class in section.value %}
3434
<li class="field-body">
35-
<b>{{ class.name }}</b>
35+
<b><code>{{ class.name }}</code></b>
3636
3737
<div class="doc-md-description">
3838
{{ class.description|convert_markdown(heading_level, html_id) }}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
{% for function in section.value %}
3636
{% if not function.name == "__init__" or not config.merge_init_into_class %}
3737
<li class="field-body">
38-
<b>{{ function.name }}</b>
38+
<b><code>{{ function.name }}</code></b>
3939
4040
<div class="doc-md-description">
4141
{{ function.description|convert_markdown(heading_level, html_id) }}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<ul>
3333
{% for module in section.value %}
3434
<li class="field-body">
35-
<b>{{ module.name }}</b>
35+
<b><code>{{ module.name }}</code></b>
3636
3737
<div class="doc-md-description">
3838
{{ module.description|convert_markdown(heading_level, html_id) }}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<ul>
4141
{% for parameter in section.value %}
4242
<li class="field-body">
43-
<b>{{ parameter.name }}</b>
43+
<b><code>{{ parameter.name }}</code></b>
4444
{% if parameter.annotation %}
4545
{% with expression = parameter.annotation %}
4646
(<code>{% include "expression.html" with context %}</code>)

src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<ul>
5151
{% for parameter in section.value %}
5252
<li class="field-body">
53-
<b>{{ parameter.name }}</b>
53+
<b><code>{{ parameter.name }}</code></b>
5454
{% if parameter.annotation %}
5555
{% with expression = parameter.annotation %}
5656
(<code>{% include "expression.html" with context %}</code>

src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<ul>
4242
{% for receives in section.value %}
4343
<li class="field-body">
44-
{% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
44+
{% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
4545
{% if receives.annotation %}
4646
{% with expression = receives.annotation %}
4747
{% if receives.name %} ({% endif %}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<ul>
4242
{% for returns in section.value %}
4343
<li class="field-body">
44-
{% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
44+
{% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
4545
{% if returns.annotation %}
4646
{% with expression = returns.annotation %}
4747
{% if returns.name %} ({% endif %}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<ul>
4242
{% for yields in section.value %}
4343
<li class="field-body">
44-
{% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
44+
{% if yields.name %}<b><code>{{ yields.name }}</code></b>{% endif %}
4545
{% if yields.annotation %}
4646
{% with expression = yields.annotation %}
4747
{% if yields.name %} ({% endif %}

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for attribute in section.value %}
1616
<li>
17-
<b>{{ attribute.name }}</b>
17+
<b><code>{{ attribute.name }}</code></b>
1818
{% if attribute.annotation %}
1919
{% with expression = attribute.annotation %}
2020
(<code>{% include "expression.html" with context %}</code>)

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for parameter in section.value %}
1616
<li>
17-
<b>{{ parameter.name }}</b>
17+
<b><code>{{ parameter.name }}</code></b>
1818
{% if parameter.annotation %}
1919
{% with expression = parameter.annotation %}
2020
(<code>{% include "expression.html" with context %}</code>)

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for parameter in section.value %}
1616
<li>
17-
<b>{{ parameter.name }}</b>
17+
<b><code>{{ parameter.name }}</code></b>
1818
{% if parameter.annotation %}
1919
{% with expression = parameter.annotation %}
2020
(<code>{% include "expression.html" with context %}</code>

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for receives in section.value %}
1616
<li>
17-
{% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
17+
{% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
1818
{% if receives.annotation %}
1919
{% with expression = receives.annotation %}
2020
{% if receives.name %}({% endif %}

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for returns in section.value %}
1616
<li>
17-
{% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
17+
{% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
1818
{% if returns.annotation %}
1919
{% with expression = returns.annotation %}
2020
{% if returns.name %}({% endif %}

src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<ul class="first simple">
1515
{% for yields in section.value %}
1616
<li>
17-
{% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
17+
{% if yields.name %}<b></code>{{ yields.name }}</code></b>{% endif %}
1818
{% if yields.annotation %}
1919
{% with expression = yields.annotation %}
2020
{% if yields.name %}({% endif %}

0 commit comments

Comments
 (0)
0