Skip to content

Commit be9653b

Browse files
committed
add more documentation
1 parent 24b2e7e commit be9653b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/gbase32_clockwork/gbase32.gleam

+16
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ pub type DecodeFn =
2222

2323
/// Create a new encoder that can be be reused to encode strings in base32 clockwork
2424
///
25+
/// ## Examples
26+
///
27+
/// ```gleam
28+
/// let encode = new_encoder()
29+
/// encode("foobar")
30+
/// // -> Ok("csqpyrk1e8")
31+
/// ```
32+
///
2533
pub fn new_encoder() -> EncodeFn {
2634
let encodebook: EncodeBook =
2735
clockwork_codebook
@@ -34,6 +42,14 @@ pub fn new_encoder() -> EncodeFn {
3442

3543
/// Create a new decoder that can be be reused to decode strings from base32 clockwork
3644
///
45+
/// ## Examples
46+
///
47+
/// ```gleam
48+
/// let decode = new_decoder()
49+
/// decode("CSQPYRK1E8")
50+
/// // -> Ok("foobar")
51+
/// ```
52+
///
3753
pub fn new_decoder() -> DecodeFn {
3854
let decodebook: DecodeBook =
3955
clockwork_codebook

0 commit comments

Comments
 (0)