From 98b1c9d1480cfa5d8e23f5f1e97796642e0f3782 Mon Sep 17 00:00:00 2001
From: Spotandjake <spotandjake@hotmail.com>
Date: Mon, 12 Feb 2024 21:02:04 -0500
Subject: [PATCH 1/2] chore(stdlib): Improve Marshal docs

---
 stdlib/marshal.gr | 10 ++++++++++
 stdlib/marshal.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/stdlib/marshal.gr b/stdlib/marshal.gr
index fe0c99f8a0..52a86457b8 100644
--- a/stdlib/marshal.gr
+++ b/stdlib/marshal.gr
@@ -3,6 +3,10 @@
  *
  * @example include "marshal"
  *
+ * @example Marshal.marshal(1)
+ * @example Marshal.marshal("Hello World")
+ * @example Marshal.unmarshal(b"\x03\x00\x00\x00")
+ *
  * @since v0.5.3
  */
 
@@ -430,6 +434,9 @@ let marshal = (value, buf) => {
  * @param value: The value to serialize
  * @returns A byte-based representation of the value
  *
+ * @example Marshal.marshal(1) == b"\x03\x00\x00\x00"
+ * @example Marshal.marshal("🌾") == Marshal.marshal('🌾')
+ *
  * @since v0.5.3
  */
 @unsafe
@@ -1056,6 +1063,9 @@ let unmarshal = buf => {
  * @param bytes: The data to deserialize
  * @returns An in-memory value
  *
+ * @example Marshal.unmarshal(Marshal.marshal('🌾')) == Ok('🌾')
+ * @example Marshal.unmarshal(b"\x03\x00\x00\x00") == Ok(1)
+ *
  * @since v0.5.3
  */
 @unsafe
diff --git a/stdlib/marshal.md b/stdlib/marshal.md
index 61ded8230d..84af92a6b6 100644
--- a/stdlib/marshal.md
+++ b/stdlib/marshal.md
@@ -13,6 +13,18 @@ No other changes yet.
 include "marshal"
 ```
 
+```grain
+Marshal.marshal(1)
+```
+
+```grain
+Marshal.marshal("Hello World")
+```
+
+```grain
+Marshal.unmarshal(b"\x03\x00\x00\x00")
+```
+
 ## Values
 
 Functions and constants included in the Marshal module.
@@ -44,6 +56,16 @@ Returns:
 |----|-----------|
 |`Bytes`|A byte-based representation of the value|
 
+Examples:
+
+```grain
+Marshal.marshal(1) == b"\x03\x00\x00\x00"
+```
+
+```grain
+Marshal.marshal("🌾") == Marshal.marshal('🌾')
+```
+
 ### Marshal.**unmarshal**
 
 <details disabled>
@@ -74,3 +96,13 @@ Returns:
 |----|-----------|
 |`Result<a, String>`|An in-memory value|
 
+Examples:
+
+```grain
+Marshal.unmarshal(Marshal.marshal('🌾')) == Ok('🌾')
+```
+
+```grain
+Marshal.unmarshal(b"\x03\x00\x00\x00") == Ok(1)
+```
+

From 83fd75f7bdb4fce56b20cb6542caf95fc3b0034f Mon Sep 17 00:00:00 2001
From: Spotandjake <spotandjake@hotmail.com>
Date: Tue, 27 Feb 2024 17:57:19 -0500
Subject: [PATCH 2/2] chore: Apply suggestions from code review

---
 stdlib/marshal.gr | 2 +-
 stdlib/marshal.md | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/stdlib/marshal.gr b/stdlib/marshal.gr
index 174c36d84c..f6f6e115cb 100644
--- a/stdlib/marshal.gr
+++ b/stdlib/marshal.gr
@@ -424,7 +424,7 @@ let marshal = (value, buf) => {
  * @returns A byte-based representation of the value
  *
  * @example Marshal.marshal(1) == b"\x03\x00\x00\x00"
- * @example Marshal.marshal("🌾") == Marshal.marshal('🌾')
+ * @example Marshal.marshal("🌾") == Marshal.marshal("🌾")
  *
  * @since v0.5.3
  */
diff --git a/stdlib/marshal.md b/stdlib/marshal.md
index cd3fe30897..679244c1b6 100644
--- a/stdlib/marshal.md
+++ b/stdlib/marshal.md
@@ -63,7 +63,7 @@ Marshal.marshal(1) == b"\x03\x00\x00\x00"
 ```
 
 ```grain
-Marshal.marshal("🌾") == Marshal.marshal('🌾')
+Marshal.marshal("🌾") == Marshal.marshal("🌾")
 ```
 
 ### Marshal.**unmarshal**