aboutsummaryrefslogtreecommitdiff
path: root/docs/structs_doc.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/structs_doc.md')
-rwxr-xr-xdocs/structs_doc.md37
1 files changed, 18 insertions, 19 deletions
diff --git a/docs/structs_doc.md b/docs/structs_doc.md
index 3b742cb..a409d86 100755
--- a/docs/structs_doc.md
+++ b/docs/structs_doc.md
@@ -1,3 +1,9 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+Skylib module containing functions that operate on structs.
+
+<a id="#structs.to_dict"></a>
+
## structs.to_dict
<pre>
@@ -6,24 +12,17 @@ structs.to_dict(<a href="#structs.to_dict-s">s</a>)
Converts a `struct` to a `dict`.
-### Parameters
-
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
- <tr id="structs.to_dict-s">
- <td><code>s</code></td>
- <td>
- required.
- <p>
- A `struct`.
- </p>
- </td>
- </tr>
- </tbody>
-</table>
+**PARAMETERS**
+
+
+| Name | Description | Default Value |
+| :------------- | :------------- | :------------- |
+| <a id="structs.to_dict-s"></a>s | A <code>struct</code>. | none |
+
+**RETURNS**
+
+A `dict` whose keys and values are the same as the fields in `s`. The
+transformation is only applied to the struct's fields and not to any
+nested values.