Skip to content

Commit d8e3c2b

Browse files
author
Ryan Miville
committed
doc fixes
1 parent fa53876 commit d8e3c2b

File tree

3 files changed

+4
-21
lines changed

3 files changed

+4
-21
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ pub fn main() {
6161
let decoder = {
6262
use name <- clad.opt("name", "n", zero.string)
6363
use age <- clad.opt("age", "a", zero.int)
64-
use enrolled <- clad.opt("enrolled", "e", clad.flag())
64+
use enrolled <- clad.flag("enrolled", "e")
6565
use classes <- clad.opt("class", "c", clad.list(zero.string))
6666
zero.success(Student(name:, age:, enrolled:, classes:))
6767
}

gleam.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name = "clad"
2-
version = "0.3.0"
2+
version = "0.3.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

+2-19
Original file line numberDiff line numberDiff line change
@@ -223,10 +223,10 @@ pub fn positional_arguments(
223223
next(args)
224224
}
225225

226-
/// A Bool decoder that returns False if value is not present
226+
/// Decode a command line flag as a Bool. Returns False if value is not present
227227
/// ```gleam
228228
/// let decoder = {
229-
/// use verbose <- zero.field("v", clad.flag())
229+
/// use verbose <- clad.flag("verbose", "v", clad.flag())
230230
/// zero.success(verbose)
231231
/// }
232232
/// let result = clad.decode(["-v"], decoder)
@@ -256,23 +256,6 @@ fn optional_field(
256256
next: fn(Option(t)) -> Decoder(final),
257257
) -> Decoder(final) {
258258
zero.optional_field(field_name, None, zero.optional(field_decoder), next)
259-
// let decoding_function = fn(data: Dynamic) {
260-
// use <- bool.guard(dynamic.classify(data) == "Nil", Ok(None))
261-
262-
// case zero.run(data, zero.optional(field_decoder)) {
263-
// Ok(None) -> {
264-
// case zero.run(data, field_decoder) {
265-
// Ok(v) -> Ok(Some(v))
266-
// Error(_) -> Ok(None)
267-
// }
268-
// }
269-
// other -> other
270-
// }
271-
// }
272-
273-
// let decoder = zero.new_primitive_decoder(decoding_function, None)
274-
275-
// zero.field(field_name, decoder, next)
276259
}
277260

278261
/// Decode a command line option by either a long name or short name

0 commit comments

Comments
 (0)