Skip to content

Commit

Permalink
refactor: Wrap docstring section elements (list style) in code tags t…
Browse files Browse the repository at this point in the history
…o prevent spell checker errors
  • Loading branch information
pawamoy committed Sep 10, 2023
1 parent 47b4115 commit 1ae8dd8
Show file tree
Hide file tree
Showing 15 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<ul>
{% for attribute in section.value %}
<li class="field-body">
<b>{{ attribute.name }}</b>
<b><code>{{ attribute.name }}</code></b>
{% if attribute.annotation %}
{% with expression = attribute.annotation %}
(<code>{% include "expression.html" with context %}</code>)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<ul>
{% for class in section.value %}
<li class="field-body">
<b>{{ class.name }}</b>
<b><code>{{ class.name }}</code></b>
<div class="doc-md-description">
{{ class.description|convert_markdown(heading_level, html_id) }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
{% for function in section.value %}
{% if not function.name == "__init__" or not config.merge_init_into_class %}
<li class="field-body">
<b>{{ function.name }}</b>
<b><code>{{ function.name }}</code></b>
<div class="doc-md-description">
{{ function.description|convert_markdown(heading_level, html_id) }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<ul>
{% for module in section.value %}
<li class="field-body">
<b>{{ module.name }}</b>
<b><code>{{ module.name }}</code></b>
<div class="doc-md-description">
{{ module.description|convert_markdown(heading_level, html_id) }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<ul>
{% for parameter in section.value %}
<li class="field-body">
<b>{{ parameter.name }}</b>
<b><code>{{ parameter.name }}</code></b>
{% if parameter.annotation %}
{% with expression = parameter.annotation %}
(<code>{% include "expression.html" with context %}</code>)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<ul>
{% for parameter in section.value %}
<li class="field-body">
<b>{{ parameter.name }}</b>
<b><code>{{ parameter.name }}</code></b>
{% if parameter.annotation %}
{% with expression = parameter.annotation %}
(<code>{% include "expression.html" with context %}</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<ul>
{% for receives in section.value %}
<li class="field-body">
{% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
{% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
{% if receives.annotation %}
{% with expression = receives.annotation %}
{% if receives.name %} ({% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<ul>
{% for returns in section.value %}
<li class="field-body">
{% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
{% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
{% if returns.annotation %}
{% with expression = returns.annotation %}
{% if returns.name %} ({% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<ul>
{% for yields in section.value %}
<li class="field-body">
{% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
{% if yields.name %}<b><code>{{ yields.name }}</code></b>{% endif %}
{% if yields.annotation %}
{% with expression = yields.annotation %}
{% if yields.name %} ({% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for attribute in section.value %}
<li>
<b>{{ attribute.name }}</b>
<b><code>{{ attribute.name }}</code></b>
{% if attribute.annotation %}
{% with expression = attribute.annotation %}
(<code>{% include "expression.html" with context %}</code>)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for parameter in section.value %}
<li>
<b>{{ parameter.name }}</b>
<b><code>{{ parameter.name }}</code></b>
{% if parameter.annotation %}
{% with expression = parameter.annotation %}
(<code>{% include "expression.html" with context %}</code>)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for parameter in section.value %}
<li>
<b>{{ parameter.name }}</b>
<b><code>{{ parameter.name }}</code></b>
{% if parameter.annotation %}
{% with expression = parameter.annotation %}
(<code>{% include "expression.html" with context %}</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for receives in section.value %}
<li>
{% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
{% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
{% if receives.annotation %}
{% with expression = receives.annotation %}
{% if receives.name %}({% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for returns in section.value %}
<li>
{% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
{% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
{% if returns.annotation %}
{% with expression = returns.annotation %}
{% if returns.name %}({% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<ul class="first simple">
{% for yields in section.value %}
<li>
{% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
{% if yields.name %}<b></code>{{ yields.name }}</code></b>{% endif %}
{% if yields.annotation %}
{% with expression = yields.annotation %}
{% if yields.name %}({% endif %}
Expand Down

0 comments on commit 1ae8dd8

Please sign in to comment.