chore(docs): Add examples to Hash module (#2011)

grain-lang · Mar 2, 2024 · b6843ce · b6843ce
1 parent 588a3b8
commit b6843ce
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/stdlib/hash.gr b/stdlib/hash.gr
@@ -3,6 +3,9 @@
  *
  * @example from "hash" include Hash
  *
+ * @example Hash.hash(1)
+ * @example Hash.hash("Hello World")
+ *
  * @since v0.1.0
  */
 module Hash
@@ -237,6 +240,9 @@ let rec hashOne = (val, depth) => {
  * @param anything: The value to hash
  * @returns A hash for the given value
  *
+ * @example assert Hash.hash(1) == Hash.hash(1)
+ * @example assert Hash.hash("Hello World") == Hash.hash("Hello World")
+ *
  * @since v0.1.0
  */
 @unsafe

diff --git a/stdlib/hash.md b/stdlib/hash.md
@@ -13,6 +13,14 @@ No other changes yet.
 from "hash" include Hash
 ```
 
+```grain
+Hash.hash(1)
+```
+
+```grain
+Hash.hash("Hello World")
+```
+
 ## Values
 
 Functions and constants included in the Hash module.
@@ -42,3 +50,13 @@ Returns:
 |----|-----------|
 |`Number`|A hash for the given value|
 
+Examples:
+
+```grain
+assert Hash.hash(1) == Hash.hash(1)
+```
+
+```grain
+assert Hash.hash("Hello World") == Hash.hash("Hello World")
+```
+