Make constructor arguments take less horizontal space and fit better

gleam-lang · Feb 21, 2025 · 504f20b · 504f20b
1 parent 538192f
commit 504f20b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 35 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,9 @@
   making Gleam packages discoverable through global search of HexDocs.
   ([Diemo Gebhardt](https://github.com/diemogebhardt))
 
+- Improved the styling of constructor argument descriptions in the generated
+  documentation. ([Nicd](https://git.ahlcode.fi/nicd))
+
 - Allow users to set the `GLEAM_CACERTS_PATH` environment variable to specify a
   path to a directory containing CA certificates to install Hex packages.
   ([winstxnhdw](https://github.com/winstxnhdw))

diff --git a/...core__docs__tests__docs_of_a_type_constructor_are_not_used_by_the_following_function.snap b/...core__docs__tests__docs_of_a_type_constructor_are_not_used_by_the_following_function.snap
@@ -1,7 +1,6 @@
 ---
 source: compiler-core/src/docs/tests.rs
 expression: "compile(config, modules)"
-snapshot_kind: text
 ---
 //// app.html
 
@@ -298,21 +297,17 @@ snapshot_kind: text
               Arguments
             </h4>
 
-            <ul class="constructor-argument-list">
+            <dl class="constructor-argument-list">
             
-              <li>
-                <div class="constructor-argument-item">
-                  <p class="constructor-argument-label">
-                    <i>wabble</i>
-                  </p>
-                  <div class="constructor-argument-doc">
-                    <p>Documentation!!</p>
-
-                  </div>
-                </div>
-              </li>
+              <dt class="constructor-argument-label">
+                wabble
+              </dt>
+              <dd class="constructor-argument-doc">
+                <p>Documentation!!</p>
+
+              </dd>
             
-            </ul>
+            </dl>
             
           </div>
         </li>

diff --git a/compiler-core/templates/docs-css/index.css b/compiler-core/templates/docs-css/index.css
@@ -565,16 +565,8 @@ body.drawer-open .label-closed {
   margin-bottom: var(--small-gap);
 }
 
-.constructor-argument-item {
-  display: flex;
-}
-
 .constructor-argument-label {
-  flex-shrink: 0;
-}
-
-.constructor-argument-doc {
-  margin-left: var(--gap);
+  font-style: italic;
 }
 
 .constructor-argument-list {

diff --git a/compiler-core/templates/documentation_module.html b/compiler-core/templates/documentation_module.html
@@ -85,20 +85,16 @@ <h4>
               Arguments
             </h4>
 
-            <ul class="constructor-argument-list">
+            <dl class="constructor-argument-list">
             {% for argument in constructor.arguments %}
-              <li>
-                <div class="constructor-argument-item">
-                  <p class="constructor-argument-label">
-                    <i>{{ argument.name }}</i>
-                  </p>
-                  <div class="constructor-argument-doc">
-                    {{ argument.doc|safe }}
-                  </div>
-                </div>
-              </li>
+              <dt class="constructor-argument-label">
+                {{ argument.name }}
+              </dt>
+              <dd class="constructor-argument-doc">
+                {{ argument.doc|safe }}
+              </dd>
             {% endfor %}
-            </ul>
+            </dl>
             {% endif %}
           </div>
         </li>