Skip to content

Commit fe16b54

Browse files
committed
feat: Use sections titles in SpaCy-styled docstrings
1 parent 0822ff9 commit fe16b54

File tree

8 files changed

+8
-8
lines changed

8 files changed

+8
-8
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<table>
5050
<thead>
5151
<tr>
52-
<th><b>ATTRIBUTE</b></th>
52+
<th><b>{{ (section.title or "ATTRIBUTE").rstrip(":").upper() }}</b></th>
5353
<th><b>DESCRIPTION</b></th>
5454
</tr>
5555
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<table>
5050
<thead>
5151
<tr>
52-
<th><b>PARAMETER</b></th>
52+
<th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
5353
<th><b>DESCRIPTION</b></th>
5454
</tr>
5555
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<table>
6060
<thead>
6161
<tr>
62-
<th><b>PARAMETER</b></th>
62+
<th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
6363
<th><b>DESCRIPTION</b></th>
6464
</tr>
6565
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<table>
4848
<thead>
4949
<tr>
50-
<th><b>RAISES</b></th>
50+
<th><b>{{ (section.title or "RAISES").rstrip(":").upper() }}</b></th>
5151
<th><b>DESCRIPTION</b></th>
5252
</tr>
5353
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<table>
5353
<thead>
5454
<tr>
55-
<th><b>RECEIVES</b></th>
55+
<th><b>{{ (section.title or "RECEIVES").rstrip(":").upper() }}</b></th>
5656
<th><b>DESCRIPTION</b></th>
5757
</tr>
5858
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<table>
5353
<thead>
5454
<tr>
55-
<th><b>RETURNS</b></th>
55+
<th><b>{{ (section.title or "RETURNS").rstrip(":").upper() }}</b></th>
5656
<th><b>DESCRIPTION</b></th>
5757
</tr>
5858
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<table>
4848
<thead>
4949
<tr>
50-
<th><b>WARNS</b></th>
50+
<th><b>{{ (section.title or "WARNS").rstrip(":").upper() }}</b></th>
5151
<th><b>DESCRIPTION</b></th>
5252
</tr>
5353
</thead>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
<table>
5353
<thead>
5454
<tr>
55-
<th><b>YIELDS</b></th>
55+
<th><b>{{ (section.title or "YIELDS").rstrip(":").upper() }}</b></th>
5656
<th><b>DESCRIPTION</b></th>
5757
</tr>
5858
</thead>

0 commit comments

Comments
 (0)