Skip to content

Commit 708cb26

Browse files
author
Ryan Miville
committed
fix flag docs
1 parent 5ad2ab3 commit 708cb26

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

gleam.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name = "clad"
2-
version = "1.0.0"
2+
version = "1.0.1"
33

44
# Fill out these fields if you intend to generate HTML documentation or publish
55
# your project to the Hex package manager.

src/clad.gleam

+5-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@
5858
//// use name <- decode.field("name", decode.string)
5959
//// use age <- decode.field("age", decode.int)
6060
//// use enrolled <- decode.field("enrolled", decode.bool)
61+
//// // ----------------------------------------------------------------------
6162
//// use classes <- decode.field("class", clad.list(decode.string))
63+
//// // ----------------------------------------------------------------------
6264
//// decode.success(Student(name:, age:, enrolled:, classes:))
6365
//// }
6466
////
@@ -105,7 +107,9 @@
105107
//// let decoder = {
106108
//// use name <- clad.opt(long_name: "name", short_name: "n", decode.string)
107109
//// use age <- clad.opt(long_name: "age", short_name: "a", decode.int)
110+
//// // ----------------------------------------------------------------------
108111
//// use enrolled <- clad.flag(long_name: "enrolled", short_name: "e")
112+
//// // ----------------------------------------------------------------------
109113
//// use classes <- clad.opt(long_name: "class", short_name: "c", clad.list(decode.string))
110114
//// decode.success(Student(name:, age:, enrolled:, classes:))
111115
//// }
@@ -192,7 +196,7 @@ pub fn positional_arguments(
192196
/// Decode a command line flag as a Bool. Returns False if value is not present
193197
/// ```gleam
194198
/// let decoder = {
195-
/// use verbose <- clad.flag("verbose", "v", decode.bool)
199+
/// use verbose <- clad.flag("verbose", "v")
196200
/// decode.success(verbose)
197201
/// }
198202
/// let result = clad.decode(["-v"], decoder)

0 commit comments

Comments
 (0)