Skip to content

Commit 2b8c916

Browse files
committed
Insert TODOs in DocC for CompletionKind cases.
Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>
1 parent 5dd7d90 commit 2b8c916

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

Sources/ArgumentParser/Parsable Properties/CompletionKind.swift

+15-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
/// the following settings, which will not affect the requesting shell outside
1616
/// the completion script:
1717
///
18+
/// TODO: investigate more settings
19+
///
1820
/// - bash:
1921
///
2022
/// ```shell
@@ -72,8 +74,19 @@ public struct CompletionKind {
7274
/// Given file extensions are parsed by the requesting shell as globs; Swift
7375
/// Argument Parser does not perform any escaping or quoting.
7476
///
75-
/// In zsh, `EXTENDED_GLOB` & `NULL_GLOB` are set, while `KSH_GLOB` & `SH_GLOB` are unset
76-
/// ? `BARE_GLOB_QUAL`, `GLOB_DOTS`, `GLOB_STAR_SHORT`, `GLOB_SUBST`, `NOMATCH`, `NUMERIC_GLOB_SORT`
77+
/// In zsh, `EXTENDED_GLOB` & `NULL_GLOB` are set, while `KSH_GLOB` &
78+
/// `SH_GLOB` are unset.
79+
///
80+
/// TODO: determine if the following should be set or unset:
81+
///
82+
/// `BARE_GLOB_QUAL`
83+
/// `GLOB_DOTS`
84+
/// `GLOB_STAR_SHORT`
85+
/// `GLOB_SUBST`
86+
/// `NOMATCH`
87+
/// `NUMERIC_GLOB_SORT`
88+
///
89+
/// TODO: determine settings for bash & fish
7790
///
7891
/// The directory/file filter & the given list of extensions are included in a
7992
/// completion script when it is generated.

0 commit comments

Comments
 (0)