Skip to content

Commit c4a6afe

Browse files
hkad98hkad98
authored
Merge pull request #984 from hkad98/jkd/docs
docs: fix malformed api-ref
2 parents d6ac7e5 + f7b161c commit c4a6afe

File tree

2 files changed

+86
-81
lines changed

2 files changed

+86
-81
lines changed

‎docs/layouts/partials/api-ref-function-parenthesis.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
{{ $funcObj := . }}
2-
{{/* Create the parenthesis string for signature. Example "(text: str, number: int) */}}
3-
{{ $parenthesisArgsString := "" }}
4-
{{ if $funcObj.docstring_parsed }}
5-
{{ range $funcObj.docstring_parsed.params}}
6-
{{ $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " }}
7-
{{ end }}
8-
{{ end }}
9-
{{ $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString }}
10-
{{trim $parenthesisArgsString " "}}
1+
{{- $funcObj := . -}}
2+
{{- /* Create the parenthesis string for signature */ -}}
3+
{{- $parenthesisArgsString := "" -}}
4+
{{- if $funcObj.docstring_parsed -}}
5+
{{- range $funcObj.docstring_parsed.params -}}
6+
{{- $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " -}}
7+
{{- end -}}
8+
{{- end -}}
9+
{{- $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString -}}
10+
{{- $parenthesisArgsString -}}

‎docs/layouts/partials/api-ref-object-partial.html‎

Lines changed: 76 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88

99
{{ $parenthesisArgsString := partial "api-ref-function-parenthesis.html" $objData}}
1010
{{ if not $objData.is_property }}
11-
<p><code>
12-
{{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
13-
</code></p>
11+
<p><code>{{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict
12+
"paragraph" $objData.signature.return_annotation "context" $context) }}</code></p>
1413
{{ else }}
15-
<p><code>
16-
{{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
17-
</code></p>
14+
<p><code>{{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph"
15+
$objData.signature.return_annotation "context" $context) }}</code></p>
1816
{{ end }}
1917

2018
{{ if $objData.docstring_parsed}}
2119
<div class="python-ref-description">
22-
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
23-
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context)}}</p>
20+
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
21+
safeHTML) "context" $context) }}</p>
22+
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
23+
safeHTML) "context" $context)}}</p>
2424
</div>
2525
{{ end }}
2626

@@ -29,51 +29,53 @@ <h4> Parameters </h4>
2929
{{ if $objData.docstring_parsed }}
3030
{{ if (index $objData.docstring_parsed "params") }}
3131
{{ if (gt (len $objData.docstring_parsed.params) 0) }}
32-
<table class="gd-docs-parameters-block">
33-
<thead>
34-
<tr>
35-
<th>name</th>
36-
<th>type</th>
37-
<th>description</th>
38-
</tr>
39-
</thead>
40-
<tbody>
41-
{{range $objData.docstring_parsed.params}}
42-
<tr>
43-
<td> {{ .arg_name }} </td>
44-
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }} </td>
45-
<td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context) }} </td>
46-
</tr>
47-
{{end}}
48-
</tbody>
49-
</table>
32+
<table class="gd-docs-parameters-block">
33+
<thead>
34+
<tr>
35+
<th>name</th>
36+
<th>type</th>
37+
<th>description</th>
38+
</tr>
39+
</thead>
40+
<tbody>
41+
{{range $objData.docstring_parsed.params}}
42+
<tr>
43+
<td> {{ .arg_name }}</td>
44+
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }}</td>
45+
<td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context)
46+
}}
47+
</td>
48+
</tr>
49+
{{end}}
50+
</tbody>
51+
</table>
5052
{{ else }}
51-
<i> None </i>
53+
<i> None </i>
5254
{{ end }}
5355
{{ else if (ne $objData.signature.return_type "None") }}
54-
<table class="gd-docs-parameters-block">
55-
<thead>
56-
<tr>
57-
<th>name</th>
58-
<th>type</th>
59-
<th>description</th>
60-
</tr>
61-
</thead>
62-
<tbody>
63-
{{range $objData.signature.params}}
64-
<tr>
65-
<td> {{ index . 0 }} </td>
66-
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }} </td>
67-
<td> <i> None </i> </td>
68-
</tr>
69-
{{end}}
70-
</tbody>
71-
</table>
56+
<table class="gd-docs-parameters-block">
57+
<thead>
58+
<tr>
59+
<th>name</th>
60+
<th>type</th>
61+
<th>description</th>
62+
</tr>
63+
</thead>
64+
<tbody>
65+
{{range $objData.signature.params}}
66+
<tr>
67+
<td> {{ index . 0 }}</td>
68+
<td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }}</td>
69+
<td><i> None </i></td>
70+
</tr>
71+
{{end}}
72+
</tbody>
73+
</table>
7274
{{ else }}
73-
<i> None </i>
75+
<i> None </i>
7476
{{ end }}
7577
{{ else }}
76-
<i> None </i>
78+
<i> None </i>
7779
{{ end }}
7880
{{ end }}
7981

@@ -84,34 +86,35 @@ <h4> Returns </h4>
8486
{{ else if or $objData.docstring_parsed.returns.type_name (ne $objData.signature.return_annotation "None") }}
8587
{{ $typeName := "" }}
8688
{{ if $objData.docstring_parsed.returns.type_name }}
87-
{{ $typeName = $objData.docstring_parsed.returns.type_name }}
89+
{{ $typeName = $objData.docstring_parsed.returns.type_name }}
8890
{{ else }}
89-
{{ $typeName = $objData.signature.return_type }}
91+
{{ $typeName = $objData.signature.return_type }}
9092
{{ end }}
9193

9294
{{ $description := $objData.docstring_parsed.returns.description }}
9395

9496
<table class="gd-docs-parameters-block">
95-
<thead>
96-
<tr>
97-
<th>type</th>
98-
<th>description</th>
99-
</tr>
100-
</thead>
101-
<tbody>
102-
<tr>
103-
<td>
104-
{{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
105-
</td>
106-
<td>
107-
{{ if $description }}
108-
{{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description | safeHTML) "context" $context) }}
109-
{{ else }}
110-
<i> None </i>
111-
{{ end }}
112-
</td>
113-
</tr>
114-
</tbody>
97+
<thead>
98+
<tr>
99+
<th>type</th>
100+
<th>description</th>
101+
</tr>
102+
</thead>
103+
<tbody>
104+
<tr>
105+
<td>
106+
{{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
107+
</td>
108+
<td>
109+
{{ if $description }}
110+
{{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description
111+
| safeHTML) "context" $context) }}
112+
{{ else }}
113+
<i> None </i>
114+
{{ end }}
115+
</td>
116+
</tr>
117+
</tbody>
115118
</table>
116119
{{ else }}
117120
<i> None </i>
@@ -124,8 +127,10 @@ <h4> Returns </h4>
124127
<h1> {{index (last 2 $path) 0}}.{{ index (last 1 $path) 0 }} </h1>
125128
{{ if $objData.docstring_parsed }}
126129
<div class="python-ref-description">
127-
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
128-
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context) }}</p>
130+
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
131+
safeHTML) "context" $context) }}</p>
132+
<p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
133+
safeHTML) "context" $context) }}</p>
129134
</div>
130135
{{ end }}
131136
{{end}}

0 commit comments

Comments
 (0)