standardize component descriptions

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html

@@ -1,4 +1,4 @@
-{# Breadcrumb to display information on the navigation hierarchy. #}
+{# Displays (and links to) the parent section(s) of the currently viewed page. #}
 {%- block breadcrumbs %}
 {#
   If we have more than 3 parents (excluding the home page) then we remove

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/copyright.html

@@ -1,4 +1,4 @@
-{# The component to display the copyrights informations set in conf.py. #}
+{# Displays the copyright information (which is defined in conf.py). #}
 {% if show_copyright and copyright %}
   <p class="copyright">
     {% if hasdoc('copyright') %}

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/edit-this-page.html

@@ -1,4 +1,4 @@
-{# A link to the edit interface of the page source in the specified VCS. #}
+{# Displays a link to the edit interface of the page source in the specified Version Control System. #}
 {% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %}
   {% set src = sourcename.split('.') %}
   <div class="tocsection editthispage">

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/icon-links.html

@@ -1,4 +1,4 @@
-{# Display the icons link as inline blocks in the navbar. #}
+{# Displays icon-links as list items. #}
 {%- macro icon_link_nav_item(url, icon, name, type, attributes='') -%}
   {%- if url | length > 2 %}
         <li class="nav-item">

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/indices.html

@@ -1,4 +1,4 @@
-{# add the indies generated from Sphinx. #}
+{# Displays links to the Sphinx-generated indices (genindex, modindex, py-modindex). #}
 <nav class="sidebar-indices-items">
   <p class="sidebar-indices-items__title" role="heading" aria-level="1">{{ _("Indices") }}</p>
   <ul class="indices-link">

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/last-updated.html

@@ -1,4 +1,4 @@
-{# Display the last time a page have been updated #}
+{# Displays the date and time that the documentation was last built. #}
 {%- if last_updated -%}
 <p class="last-updated">
   {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-icon-links.html

@@ -1,4 +1,4 @@
-{# Display the icons link as inline blocks in the navbar. #}
+{# Displays icon-links in the header navbar. #}
 {%- block icon_links -%}
   {%- include "icon-links.html" with context -%}
 {%- endblock icon_links %}

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-logo.html

@@ -1,4 +1,4 @@
-{# The logo of your documentation. #}
+{# Displays the logo of your documentation site, in the header navbar. #}
 {# Logo link generation -#}
 {% if not theme_logo.get("link") %}
   {% set href = pathto(root_doc) %}

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html

@@ -1,4 +1,4 @@
-{# The links of the first level toctree displayed in the header navbar. #}
+{# Displays links to the top-level TOCtree elements, in the header navbar. #}
 <nav class="navbar-nav">
   <p class="sidebar-header-items__title"
      role="heading"

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html

@@ -1,4 +1,4 @@
-{# Display the current page TOC.  #}
+{# Displays the current page's Table of Contents.  #}
 {% set page_toc = generate_toc_html() %}
 {%- if page_toc | length >= 1 %}
   <div class="page-toc tocsection onthispage">

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/prev-next.html

@@ -1,4 +1,4 @@
-{# Previous / next buttons. #}
+{# Displays links to the previous and next page in the TOCtree order. #}
 <div class="prev-next-area">
   {%- if prev %}
     <a class="left-prev"

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button-field.html

@@ -1,4 +1,4 @@
-{# Behaves the same as `search-button.html` but looks more like a search field. #}
+{# Displays a search field image that opens a search overlay when clicked. #}
 {# As this function will only work when JavaScript is enabled, we add it through JavaScript. #}
  <script>
  document.write(`

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button.html

@@ -1,4 +1,4 @@
-{# A button that, when clicked, will trigger a search popup overlay. #}
+{# Displays a magnifying glass icon that opens a search overlay when clicked. #}
 {# As this function will only work when JavaScript is enabled, we add it through JavaScript. #}
 <script>
 document.write(`

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-field.html

@@ -1,4 +1,4 @@
-{# A bootstrap-styled field that will direct to the `search.html` page when submitted. #}
+{# Displays an interactive search field directly on the page. #}
 <form class="bd-search d-flex align-items-center"
       action="{{ pathto('search') }}"
       method="get">

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/searchbox.html

@@ -1,2 +1,2 @@
-{# div#searchbox hosts the "Hide Search Matches" link #}
+{# An empty container that holds the "Hide Search Matches" button when it's needed. #}
 <div id="searchbox"></div>

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sidebar-ethical-ads.html

@@ -1,4 +1,4 @@
-{# Placeholder where the ReadTheDocs ethical ads will be placed. #}
+{# For sites hosted on ReadTheDocs, displays "ethical ads". #}
 {% if READTHEDOCS %}
   <div id="ethical-ad-placement"
        class="flat"

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sidebar-nav-bs.html

@@ -1,4 +1,4 @@
-{# Add the toctree of each page included under the selected Heading 1 from header navbar. #}
+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}
 <nav class="bd-docs-nav bd-links"
      aria-label="{{ _('Section Navigation') }}">
   <p class="bd-links__title" role="heading" aria-level="1">{{ _("Section Navigation") }}</p>

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/sourcelink.html

@@ -1,4 +1,4 @@
-{# If enabled, create a button to display the .rst source of the displayed page. #}
+{# Displays a link to the .rst source of the current page. #}
 {% if show_source and has_source and sourcename %}
   <div class="tocsection sourcelink">
     <a href="{{ pathto('_sources/' + sourcename, true)|e }}">