Merge pull request #565 from shibomb/fix/show-param-type-return-refer…

…ence Fix: Show param type and return in reference page.
processing · Sep 23, 2024 · f0d7491 · f0d7491
2 parents d6a9b2e + bfb57eb
commit f0d7491
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/src/content/ui/en.yaml b/src/content/ui/en.yaml
@@ -36,6 +36,7 @@ Syntax: Syntax
 Methods: Methods
 Fields: Fields
 Parameters: Parameters
+Returns: Returns
 Related References: Related References
 Related Examples: Related Examples
 Show Code: Show Code

diff --git a/src/layouts/ReferenceItemLayout.astro b/src/layouts/ReferenceItemLayout.astro
@@ -141,10 +141,12 @@ const seenParams: Record<string, true> = {};
                 entry.data.params.map((param: ReferenceParam) => (
                   <div class="grid grid-cols-6 gap-gutter-md text-body">
                     <span class="col-span-1 text-body">{param.name}</span>
-                    <span
-                      class="col-span-5 [&_p]:m-0 [&_a]:underline"
-                      set:html={param.description}
-                    />
+                    <div
+                          class="col-span-5 [&_p]:m-0 [&_p]:inline [&_a]:underline"
+                    >
+                      {param.type && <span>{param.type}: </span>}
+                      <span set:html={param.description} />
+                    </div>
                   </div>
                 ))}
               {entry.data.overloads &&
@@ -169,6 +171,23 @@ const seenParams: Record<string, true> = {};
           </>
         )
       }
+      {
+        (entry.data.return) && (
+          <>
+            <div class="mb-xl">
+              <h2 class="mb-md text-h3">{t("Returns")}</h2>
+              <div class="grid grid-cols-6 gap-gutter-md text-body">
+                <div
+                      class="col-span-5 [&_p]:m-0 [&_p]:inline [&_a]:underline"
+                >
+                  {entry.data.return.type && <span>{entry.data.return.type}: </span>}
+                  <span set:html={entry.data.return.description} />
+                </div>
+              </div>
+            </div>
+          </>
+        )
+      }
       {
         entry.data.properties && (
           <div class="mb-xl">