Skip to content

Commit 6541df2

Browse files
committed
docs: Note user-values subject to value_delimiter
Inspired by #4999
1 parent 1289534 commit 6541df2

File tree

1 file changed

+10
-0
lines changed
  • clap_builder/src/builder

1 file changed

+10
-0
lines changed

clap_builder/src/builder/arg.rs

+10
Original file line numberDiff line numberDiff line change
@@ -1650,6 +1650,8 @@ impl Arg {
16501650
/// at runtime, nor were the conditions met for `Arg::default_value_if`, the `Arg::default_value`
16511651
/// will be applied.
16521652
///
1653+
/// Like with command-line values, this will be split by [`Arg::value_delimiter`].
1654+
///
16531655
/// # Examples
16541656
///
16551657
/// First we use the default value without providing any value at runtime.
@@ -1747,6 +1749,8 @@ impl Arg {
17471749
/// [`.require_equals(true)`][Arg::require_equals] configuration option. These are required in
17481750
/// order to unambiguously determine what, if any, value was supplied for the argument.
17491751
///
1752+
/// Like with command-line values, this will be split by [`Arg::value_delimiter`].
1753+
///
17501754
/// # Examples
17511755
///
17521756
/// For POSIX style `--color`:
@@ -1893,6 +1897,8 @@ impl Arg {
18931897
/// [`ArgMatches::get_one`][crate::ArgMatches::get_one] will
18941898
/// return the default specified.
18951899
///
1900+
/// Like with command-line values, this will be split by [`Arg::value_delimiter`].
1901+
///
18961902
/// # Examples
18971903
///
18981904
/// In this example, we show the variable coming from the environment:
@@ -2734,6 +2740,8 @@ impl Arg {
27342740
/// and `Arg::default_value_if`, and the user **did not** provide this arg at runtime, nor were
27352741
/// the conditions met for `Arg::default_value_if`, the `Arg::default_value` will be applied.
27362742
///
2743+
/// Like with command-line values, this will be split by [`Arg::value_delimiter`].
2744+
///
27372745
/// # Examples
27382746
///
27392747
/// First we use the default value only if another arg is present at runtime.
@@ -2873,6 +2881,8 @@ impl Arg {
28732881
/// **NOTE**: The conditions are stored in order and evaluated in the same order. I.e. the first
28742882
/// if multiple conditions are true, the first one found will be applied and the ultimate value.
28752883
///
2884+
/// Like with command-line values, this will be split by [`Arg::value_delimiter`].
2885+
///
28762886
/// # Examples
28772887
///
28782888
/// First we use the default value only if another arg is present at runtime.

0 commit comments

Comments
 (0)