Skip to content

Commit 9a71866

Browse files
authored
Harmonize Option initializers abstracts (#395)
Providing missing documentation to all completionKind parameters
1 parent 0b17e34 commit 9a71866

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Sources/ArgumentParser/Parsable Properties/Option.swift

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ extension Option where Value: ExpressibleByArgument {
182182
/// - name: A specification for what names are allowed for this flag.
183183
/// - parsingStrategy: The behavior to use when looking for this option's value.
184184
/// - help: Information about how to use this option.
185+
/// - completion: Kind of completion provided to the user for this option.
185186
public init(
186187
name: NameSpecification = .long,
187188
parsing parsingStrategy: SingleValueParsingStrategy = .next,
@@ -340,6 +341,7 @@ extension Option {
340341
/// - parsingStrategy: The behavior to use when looking for this option's
341342
/// value.
342343
/// - help: Information about how to use this option.
344+
/// - completion: Kind of completion provided to the user for this option.
343345
public init<T: ExpressibleByArgument>(
344346
name: NameSpecification = .long,
345347
parsing parsingStrategy: SingleValueParsingStrategy = .next,
@@ -404,6 +406,7 @@ extension Option {
404406
/// - name: A specification for what names are allowed for this flag.
405407
/// - parsingStrategy: The behavior to use when looking for this option's value.
406408
/// - help: Information about how to use this option.
409+
/// - completion: Kind of completion provided to the user for this option.
407410
/// - transform: A closure that converts a string into this property's type or throws an error.
408411
public init(
409412
wrappedValue: Value,
@@ -435,6 +438,7 @@ extension Option {
435438
/// - name: A specification for what names are allowed for this flag.
436439
/// - parsingStrategy: The behavior to use when looking for this option's value.
437440
/// - help: Information about how to use this option.
441+
/// - completion: Kind of completion provided to the user for this option.
438442
/// - transform: A closure that converts a string into this property's type or throws an error.
439443
public init(
440444
name: NameSpecification = .long,
@@ -502,6 +506,7 @@ extension Option {
502506
/// - parsingStrategy: The behavior to use when parsing multiple values
503507
/// from the command-line arguments.
504508
/// - help: Information about how to use this option.
509+
/// - completion: Kind of completion provided to the user for this option.
505510
public init<Element>(
506511
wrappedValue: [Element],
507512
name: NameSpecification = .long,
@@ -530,6 +535,7 @@ extension Option {
530535
/// - name: A specification for what names are allowed for this flag.
531536
/// - parsingStrategy: The behavior to use when parsing multiple values from the command-line arguments.
532537
/// - help: Information about how to use this option.
538+
/// - completion: Kind of completion provided to the user for this option.
533539
public init<Element>(
534540
name: NameSpecification = .long,
535541
parsing parsingStrategy: ArrayParsingStrategy = .singleValue,
@@ -608,6 +614,7 @@ extension Option {
608614
/// - parsingStrategy: The behavior to use when parsing multiple values
609615
/// from the command-line arguments.
610616
/// - help: Information about how to use this option.
617+
/// - completion: Kind of completion provided to the user for this option.
611618
/// - transform: A closure that converts a string into this property's
612619
/// element type or throws an error.
613620
public init<Element>(
@@ -640,6 +647,7 @@ extension Option {
640647
/// - name: A specification for what names are allowed for this flag.
641648
/// - parsingStrategy: The behavior to use when parsing multiple values from the command-line arguments.
642649
/// - help: Information about how to use this option.
650+
/// - completion: Kind of completion provided to the user for this option.
643651
/// - transform: A closure that converts a string into this property's element type or throws an error.
644652
public init<Element>(
645653
name: NameSpecification = .long,

0 commit comments

Comments
 (0)