Skip to content

Commit

Permalink
Document that fish only supports named args
Browse files Browse the repository at this point in the history
  • Loading branch information
intgr committed Jul 31, 2020
1 parent 8bc558d commit 89bda82
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/build/arg/value_hint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::str::FromStr;
///
/// Overview of which hints are supported by which shell:
///
/// | Hint | zsh | fish |
/// | Hint | zsh | fish[^1]|
/// | ---------------------- | --- | ------- |
/// | `AnyPath` | Yes | Yes |
/// | `FilePath` | Yes | Yes |
Expand All @@ -19,6 +19,9 @@ use std::str::FromStr;
/// | `Hostname` | Yes | Yes |
/// | `Url` | Yes | |
/// | `EmailAddress` | Yes | |
///
/// [^1]: fish completions currently only support named arguments (e.g. -o or --opt), not
/// positional arguments.
#[derive(Debug, PartialEq, Copy, Clone)]
pub enum ValueHint {
/// Default value if hint is not specified. Follows shell default behavior, which is usually
Expand Down

0 comments on commit 89bda82

Please sign in to comment.