From 5c3429bbd54bfafa6eea6707549e26657564d9a2 Mon Sep 17 00:00:00 2001 From: John Downey Date: Mon, 29 Dec 2025 11:02:16 -0600 Subject: [PATCH] Clean up docs by hiding internal functions --- src/clip/arg.gleam | 9 ++++----- src/clip/flag.gleam | 5 ++--- src/clip/help.gleam | 3 +-- src/clip/opt.gleam | 5 ++--- 4 files changed, 9 insertions(+), 13 deletions(-) diff --git a/src/clip/arg.gleam b/src/clip/arg.gleam index 3093e22..d234554 100644 --- a/src/clip/arg.gleam +++ b/src/clip/arg.gleam @@ -29,19 +29,19 @@ fn pos_info(arg: Arg(a)) -> PositionalInfo { ) } -/// Used internally, not intended for direct usage. +@internal pub fn to_arg_info(arg: Arg(a)) -> ArgInfo { ArgInfo(..arg_info.empty(), positional: [pos_info(arg)]) } -/// Used internally, not intended for direct usage. +@internal pub fn to_arg_info_many(arg: Arg(a)) -> ArgInfo { ArgInfo(..arg_info.empty(), positional: [ PositionalInfo(..pos_info(arg), repeat: ManyRepeat), ]) } -/// Used internally, not intended for direct usage. +@internal pub fn to_arg_info_many1(arg: Arg(a)) -> ArgInfo { ArgInfo(..arg_info.empty(), positional: [ PositionalInfo(..pos_info(arg), repeat: Many1Repeat), @@ -169,8 +169,7 @@ fn run_aux( } } -/// Run an `Arg(a)` against a list of arguments. Used internally by `clip`, not -/// intended for direct usage. +@internal pub fn run( arg: Arg(a), args: List(String), diff --git a/src/clip/flag.gleam b/src/clip/flag.gleam index adb99b6..91ecd80 100644 --- a/src/clip/flag.gleam +++ b/src/clip/flag.gleam @@ -10,7 +10,7 @@ pub opaque type Flag { Flag(name: String, help: Option(String), short: Option(String)) } -/// Used internally, not intended for direct usage. +@internal pub fn to_arg_info(flag: Flag) -> ArgInfo { ArgInfo(..arg_info.empty(), flags: [ FlagInfo(name: flag.name, short: flag.short, help: flag.help), @@ -42,8 +42,7 @@ pub fn short(flag: Flag, short: String) -> Flag { Flag(..flag, short: Some(short)) } -/// Run a `Flag` against a list of arguments. Used internally by `clip`, not -/// intended for direct usage. +@internal pub fn run( flag: Flag, args: List(String), diff --git a/src/clip/help.gleam b/src/clip/help.gleam index dba62ba..e6a295a 100644 --- a/src/clip/help.gleam +++ b/src/clip/help.gleam @@ -6,8 +6,7 @@ pub opaque type Help { Help(f: fn(ArgInfo) -> String) } -/// Produce a `String` from a `Help` and an `ArgInfo`. Used internally by -/// `clip`, not intended for direct usage. +@internal pub fn run(help: Help, arg_info: ArgInfo) -> String { help.f(arg_info) } diff --git a/src/clip/opt.gleam b/src/clip/opt.gleam index e740a17..7994f35 100644 --- a/src/clip/opt.gleam +++ b/src/clip/opt.gleam @@ -18,7 +18,7 @@ pub opaque type Opt(a) { ) } -/// Used internally, not intended for direct usage. +@internal pub fn to_arg_info(opt: Opt(a)) -> ArgInfo { ArgInfo(..arg_info.empty(), named: [ NamedInfo( @@ -140,8 +140,7 @@ pub fn float(opt: Opt(String)) -> Opt(Float) { }) } -/// Run an `Opt(a)` against a list of arguments. Used internally by `clip`, not -/// intended for direct usage. +@internal pub fn run( opt: Opt(a), args: List(String),