docs: add Null to examples

vladfaust · Oct 18, 2018 · 242027b · 242027b
1 parent 2163b2c
commit 242027b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -57,8 +57,11 @@ struct MyParams
     # Therefore, "additional_data", "AdditionalData", "additionalData" and "additional-data" is OK
     additional_data: {
       email: String,
-      bio:       String | Nil,  # Alternative syntax for nilable params
-      tags:      Array(String), # Arrays are supported too
+      # This param can have explicit Null value
+      # i.e. "null" string for query-like params
+      # and `null` value for JSON.
+      bio: Union(String | Nil | Null),
+      tags: Array(String), # Arrays are supported too
 
       # Nesting is possible with ∞ levels
       deep: {

diff --git a/src/params.cr b/src/params.cr
@@ -43,8 +43,11 @@ module Params
   #       #
   #       # So, "the_email", "TheEmail", "theEmail" and "the-email" is expected for this param
   #       the_email: String,
-  #       bio:       String | Nil,  # Alternative syntax for nilable params
-  #       tags:      Array(String), # Arrays are supported too
+  #       # This param can have explicit Null value
+  #       # i.e. "null" string for query-like params
+  #       # and `null` value for JSON.
+  #       bio:  Union(String | Nil | Null),
+  #       tags: Array(String), # Arrays are supported too
   #
   #       # Nesting is possible with ∞ levels
   #       deep: {