Skip to content

Commit b58a10c

Browse files
committed
Clarify comment in template
1 parent 12e924a commit b58a10c

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

rerun_py/docs/templates/python/material/class.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@
7575
{% set heading_level = heading_level - 1 %}
7676
{% endif %}
7777

78-
{# CHANGE: disable gating of first for root docstring #}
78+
{# CHANGE Relative to Upstream: don't apply the 'first' class since it causes worse CSS formatting for our #}
79+
{# generated common API index since we inline bare functions that become root-level rather than modules. #}
7980
{#<div class="doc doc-contents {% if root %}first{% endif %}">#}
8081
<div class="doc doc-contents">
8182
{% if config.show_bases and class.bases %}

rerun_py/docs/templates/python/material/function.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,10 @@
6464
{% set heading_level = heading_level - 1 %}
6565
{% endif %}
6666

67-
{# CHANGE: disable gating of first for root docstring #}
67+
{# CHANGE Relative to Upstream: don't apply the 'first' class since it causes worse CSS formatting for our #}
68+
{# generated common API index since we inline bare functions that become root-level rather than modules. #}
6869
{#<div class="doc doc-contents {% if root %}first{% endif %}">#}
69-
<div class="doc doc-contents {% if root %}{% endif %}">
70+
<div class="doc doc-contents">
7071
{% with docstring_sections = function.docstring.parsed %}
7172
{% include "docstring.html" with context %}
7273
{% endwith %}

0 commit comments

Comments
 (0)