{#- Template for "Parameters" sections in docstrings.

This template renders a list of documented parameters in the format
specified with the [`docstring_section_style`][] configuration option.

Context:
  section (griffe.DocstringSectionAttributes): The section to render.
-#}

{% block logs scoped %}
  {#- Logging block.

  This block can be used to log debug messages, deprecation messages, warnings, etc.
  -#}
  {{ log.debug("Rendering parameters section") }}
{% endblock logs %}

{% import "language.html.jinja" as lang with context %}
{#- Language module providing the `t` translation method. -#}

{% if config.docstring_section_style == "table" %}
  {% block table_style scoped %}
    {#- Block for the `table` section style. -#}
    <p><span class="doc-section-title">{{ section.title or lang.t("Parameters:") }}</span></p>
    <table>
      <thead>
        <tr>
          <th>{{ lang.t("Name") }}</th>
          <th>{{ lang.t("Type") }}</th>
          <th>{{ lang.t("Description") }}</th>
          <th>{{ lang.t("Default") }}</th>
        </tr>
      </thead>
      <tbody>
        {% for parameter in section.value %}
          <tr class="doc-section-item">
            <td>
              {% if config.parameter_headings %}
                {% filter heading(
                    heading_level + 1,
                    role="param",
                    id=html_id ~ "(" ~ parameter.name ~ ")",
                    class="doc doc-heading doc-heading-parameter",
                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
                    skip_inventory=config.skip_local_inventory,
                  ) %}
                  <code>{{ parameter.name }}</code>
                {% endfilter %}
              {% else %}
                <code>{{ parameter.name }}</code>
              {% endif %}
            </td>
            <td>
              {% if parameter.annotation %}
                {% with expression = parameter.annotation, backlink_type = "used-by" %}
                  <code>{% include "expression.html.jinja" with context %}</code>
                {% endwith %}
              {% endif %}
            </td>
            <td>
              <div class="doc-md-description">
                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
              </div>
            </td>
            <td>
              {% if parameter.default %}
                {% with expression = parameter.default, backlink_type = "used-by" %}
                  <code>{% include "expression.html.jinja" with context %}</code>
                {% endwith %}
              {% else %}
                <em>{{ lang.t("required") }}</em>
              {% endif %}
            </td>
          </tr>
        {% endfor %}
      </tbody>
    </table>
  {% endblock table_style %}
{% elif config.docstring_section_style == "list" %}
  {% block list_style scoped %}
    {#- Block for the `list` section style. -#}
    <p><span class="doc-section-title">{{ section.title or lang.t("Parameters:") }}</span></p>
    <ul>
      {% for parameter in section.value %}
        <li class="doc-section-item field-body">
          {% if config.parameter_headings %}
            {% filter heading(
                heading_level + 1,
                role="param",
                id=html_id ~ "(" ~ parameter.name ~ ")",
                class="doc doc-heading doc-heading-parameter",
                toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
                skip_inventory=config.skip_local_inventory,
              ) %}
              <b><code>{{ parameter.name }}</code></b>
            {% endfilter %}
          {% else %}
            <b><code>{{ parameter.name }}</code></b>
          {% endif %}
          {% if parameter.annotation %}
            {% with expression = parameter.annotation, backlink_type = "used-by" %}
              (<code>{% include "expression.html.jinja" with context %}</code>
              {%- if parameter.default %}, {{ lang.t("default:") }}
                {% with expression = parameter.default, backlink_type = "used-by" %}
                  <code>{% include "expression.html.jinja" with context %}</code>
                {% endwith %}
              {% endif %})
            {% endwith %}
          {% endif %}
          –
          <div class="doc-md-description">
            {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
          </div>
        </li>
      {% endfor %}
    </ul>
  {% endblock list_style %}
{% elif config.docstring_section_style == "spacy" %}
  {% block spacy_style scoped %}
    {#- Block for the `spacy` section style. -#}
    <table>
      <thead>
        <tr>
          <th><span class="doc-section-title">{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</span></th>
          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
        </tr>
      </thead>
      <tbody>
        {% for parameter in section.value %}
          <tr class="doc-section-item">
            <td>
              {% if config.parameter_headings %}
                {% filter heading(
                    heading_level + 1,
                    role="param",
                    id=html_id ~ "(" ~ parameter.name ~ ")",
                    class="doc doc-heading doc-heading-parameter",
                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + parameter.name,
                    skip_inventory=config.skip_local_inventory,
                  ) %}
                  <code>{{ parameter.name }}</code>
                {% endfilter %}
              {% else %}
                <code>{{ parameter.name }}</code>
              {% endif %}
            </td>
            <td class="doc-param-details">
              <div class="doc-md-description">
                {{ parameter.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
              </div>
              <p>
                {% if parameter.annotation %}
                  <span class="doc-param-annotation">
                    <b>{{ lang.t("TYPE:") }}</b>
                    {% with expression = parameter.annotation, backlink_type = "used-by" %}
                      <code>{% include "expression.html.jinja" with context %}</code>
                    {% endwith %}
                  </span>
                {% endif %}
                {% if parameter.default %}
                  <span class="doc-param-default">
                    <b>{{ lang.t("DEFAULT:") }}</b>
                    {% with expression = parameter.default, backlink_type = "used-by" %}
                      <code>{% include "expression.html.jinja" with context %}</code>
                    {% endwith %}
                  </span>
                {% endif %}
              </p>
            </td>
          </tr>
        {% endfor %}
      </tbody>
    </table>
  {% endblock spacy_style %}
{% endif %}
