From f7b161c706f00e1881a5536807d2b1fe274e9c4b Mon Sep 17 00:00:00 2001
From: Jan Kadlec <kadlino98@seznam.cz>
Date: Wed, 12 Feb 2025 07:33:15 +0100
Subject: [PATCH] docs: fix malformed api-ref

The api reference code was malformed, with redundant whitespaces at the beginning and whitespaces wrapping parameters.

JIRA: DP-3082
risk: low
---
 .../api-ref-function-parenthesis.html         |  20 +--
 .../partials/api-ref-object-partial.html      | 147 +++++++++---------
 2 files changed, 86 insertions(+), 81 deletions(-)

diff --git a/docs/layouts/partials/api-ref-function-parenthesis.html b/docs/layouts/partials/api-ref-function-parenthesis.html
index 9850f4be5..1f648ed6f 100644
--- a/docs/layouts/partials/api-ref-function-parenthesis.html
+++ b/docs/layouts/partials/api-ref-function-parenthesis.html
@@ -1,10 +1,10 @@
-{{ $funcObj := . }}
-{{/* Create the parenthesis string for signature. Example "(text: str, number: int) */}}
-{{ $parenthesisArgsString := "" }}
-{{ if $funcObj.docstring_parsed }}
-{{ range $funcObj.docstring_parsed.params}}
-    {{ $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " }}
-{{ end }}
-{{ end }}
-{{ $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString }}
-{{trim $parenthesisArgsString " "}}
+{{- $funcObj := . -}}
+{{- /* Create the parenthesis string for signature */ -}}
+{{- $parenthesisArgsString := "" -}}
+{{- if $funcObj.docstring_parsed -}}
+{{- range $funcObj.docstring_parsed.params -}}
+{{- $parenthesisArgsString = print $parenthesisArgsString .arg_name ": " .type_name ", " -}}
+{{- end -}}
+{{- end -}}
+{{- $parenthesisArgsString := strings.TrimRight ", " $parenthesisArgsString -}}
+{{- $parenthesisArgsString -}}
diff --git a/docs/layouts/partials/api-ref-object-partial.html b/docs/layouts/partials/api-ref-object-partial.html
index 2466edea8..4a099fd65 100644
--- a/docs/layouts/partials/api-ref-object-partial.html
+++ b/docs/layouts/partials/api-ref-object-partial.html
@@ -8,19 +8,19 @@
 
 {{ $parenthesisArgsString := partial "api-ref-function-parenthesis.html" $objData}}
 {{ if not $objData.is_property }}
-<p><code>
-    {{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
-</code></p>
+<p><code>{{ (index (last 1 $path) 0) }}({{- $parenthesisArgsString -}}) -> {{ partial "api-ref-link-partial.html" (dict
+    "paragraph" $objData.signature.return_annotation "context" $context) }}</code></p>
 {{ else }}
-    <p><code>
-    {{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph" $objData.signature.return_annotation "context" $context) }}
-    </code></p>
+<p><code>{{ (index (last 1 $path) 0) }} -> {{ partial "api-ref-link-partial.html" (dict "paragraph"
+    $objData.signature.return_annotation "context" $context) }}</code></p>
 {{ end }}
 
 {{ if $objData.docstring_parsed}}
 <div class="python-ref-description">
-    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
-    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context)}}</p>
+    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
+        safeHTML) "context" $context) }}</p>
+    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
+        safeHTML) "context" $context)}}</p>
 </div>
 {{ end }}
 
@@ -29,51 +29,53 @@ <h4> Parameters </h4>
 {{ if $objData.docstring_parsed }}
 {{ if (index $objData.docstring_parsed "params") }}
 {{ if (gt (len $objData.docstring_parsed.params)  0) }}
-    <table class="gd-docs-parameters-block">
-        <thead>
-            <tr>
-                <th>name</th>
-                <th>type</th>
-                <th>description</th>
-            </tr>
-        </thead>
-        <tbody>
-        {{range $objData.docstring_parsed.params}}
-            <tr>
-                <td> {{ .arg_name }} </td>
-                <td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }} </td>
-                <td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context) }} </td>
-            </tr>
-        {{end}}
-        </tbody>
-    </table>
+<table class="gd-docs-parameters-block">
+    <thead>
+    <tr>
+        <th>name</th>
+        <th>type</th>
+        <th>description</th>
+    </tr>
+    </thead>
+    <tbody>
+    {{range $objData.docstring_parsed.params}}
+    <tr>
+        <td> {{ .arg_name }}</td>
+        <td> {{ partial "api-ref-link-partial.html" (dict "paragraph" .type_name "context" $context) }}</td>
+        <td> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" (.description | safeHTML) "context" $context)
+            }}
+        </td>
+    </tr>
+    {{end}}
+    </tbody>
+</table>
 {{ else }}
-    <i> None </i>
+<i> None </i>
 {{ end }}
 {{ else if (ne $objData.signature.return_type "None") }}
-    <table class="gd-docs-parameters-block">
-        <thead>
-            <tr>
-                <th>name</th>
-                <th>type</th>
-                <th>description</th>
-            </tr>
-        </thead>
-        <tbody>
-        {{range $objData.signature.params}}
-            <tr>
-                <td> {{ index . 0 }} </td>
-                <td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }} </td>
-                <td> <i> None </i> </td>
-            </tr>
-        {{end}}
-        </tbody>
-    </table>
+<table class="gd-docs-parameters-block">
+    <thead>
+    <tr>
+        <th>name</th>
+        <th>type</th>
+        <th>description</th>
+    </tr>
+    </thead>
+    <tbody>
+    {{range $objData.signature.params}}
+    <tr>
+        <td> {{ index . 0 }}</td>
+        <td> {{ partial "api-ref-link-partial.html" (dict "paragraph" (index . 1) "context" $context) }}</td>
+        <td><i> None </i></td>
+    </tr>
+    {{end}}
+    </tbody>
+</table>
 {{ else }}
-    <i> None </i>
+<i> None </i>
 {{ end }}
 {{ else }}
-    <i> None </i>
+<i> None </i>
 {{ end }}
 {{ end }}
 
@@ -84,34 +86,35 @@ <h4> Returns </h4>
 {{ else if or $objData.docstring_parsed.returns.type_name (ne $objData.signature.return_annotation "None") }}
 {{ $typeName := "" }}
 {{ if $objData.docstring_parsed.returns.type_name }}
-    {{ $typeName = $objData.docstring_parsed.returns.type_name }}
+{{ $typeName = $objData.docstring_parsed.returns.type_name }}
 {{ else }}
-    {{ $typeName = $objData.signature.return_type }}
+{{ $typeName = $objData.signature.return_type }}
 {{ end }}
 
 {{ $description := $objData.docstring_parsed.returns.description }}
 
 <table class="gd-docs-parameters-block">
-<thead>
-<tr>
-<th>type</th>
-<th>description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>
-    {{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
-</td>
-<td>
-    {{ if $description }}
-    {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description | safeHTML) "context" $context) }}
-    {{ else }}
-    <i> None </i>
-    {{ end }}
-</td>
-</tr>
-</tbody>
+    <thead>
+    <tr>
+        <th>type</th>
+        <th>description</th>
+    </tr>
+    </thead>
+    <tbody>
+    <tr>
+        <td>
+            {{ partial "api-ref-link-partial.html" (dict "paragraph" $typeName "context" $context) }}
+        </td>
+        <td>
+            {{ if $description }}
+            {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.returns.description
+            | safeHTML) "context" $context) }}
+            {{ else }}
+            <i> None </i>
+            {{ end }}
+        </td>
+    </tr>
+    </tbody>
 </table>
 {{ else }}
 <i> None </i>
@@ -124,8 +127,10 @@ <h4> Returns </h4>
 <h1> {{index (last 2 $path) 0}}.{{ index (last 1 $path) 0 }} </h1>
 {{ if $objData.docstring_parsed }}
 <div class="python-ref-description">
-    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description | safeHTML) "context" $context) }}</p>
-    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description | safeHTML) "context" $context) }}</p>
+    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.short_description |
+        safeHTML) "context" $context) }}</p>
+    <p> {{ partial "api-ref-link-all-partial.html" (dict "paragraph" ($objData.docstring_parsed.long_description |
+        safeHTML) "context" $context) }}</p>
 </div>
 {{ end }}
 {{end}}