Skip to content

Commit f8b5e71

Browse files
authored
Update DocC curation for newest symbols (#507)
1 parent b99e170 commit f8b5e71

File tree

8 files changed

+64
-19
lines changed

8 files changed

+64
-19
lines changed

Sources/ArgumentParser/Documentation.docc/Extensions/Argument.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,20 @@
44

55
### Single Arguments
66

7-
- ``init(help:completion:)-6pqzn``
8-
- ``init(help:completion:transform:)``
7+
- ``init(help:completion:)-6mld0``
98
- ``init(help:completion:)-4p94d``
10-
- ``init(wrappedValue:help:completion:)``
11-
- ``init(wrappedValue:help:completion:transform:)``
9+
- ``init(help:completion:transform:)-3fjtc``
10+
- ``init(help:completion:transform:)-7yn32``
11+
12+
@Comment {
13+
The following symbols are copied from the preview website, but give a warning
14+
when built and don't show up in this section in the rendered navigation in
15+
either Xcode or the preview website. Instead, these symbols end up in the
16+
default-generated Initializers section.
17+
}
18+
19+
- ``init(wrappedvalue:help:completion:)``
20+
- ``init(wrappedvalue:help:completion:transform:)``
1221

1322
### Array Arguments
1423

@@ -20,6 +29,5 @@
2029

2130
### Infrequently Used APIs
2231

23-
- ``init()``
2432
- ``init(from:)``
2533
- ``wrappedValue``
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ``ArgumentParser/ArgumentArrayParsingStrategy``
2+
3+
## Topics
4+
5+
### Parsing Strategies
6+
7+
- ``remaining``
8+
- ``allUnrecognized``
9+
- ``postTerminator``
10+
- ``captureForPassthrough``
11+
12+
### Deprecated
13+
14+
- ``unconditionalRemaining``

Sources/ArgumentParser/Documentation.docc/Extensions/Flag.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,3 @@
3333
### Supporting Types
3434

3535
- ``FlagExclusivity``
36-
37-
### Deprecated APIs
38-
39-
- ``init()``

Sources/ArgumentParser/Documentation.docc/Extensions/Option.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,28 @@
44

55
### Single Options
66

7-
- ``init(name:parsing:help:completion:)-4yske``
87
- ``init(name:parsing:help:completion:)-7slrf``
8+
- ``init(name:parsing:help:completion:)-5k0ug``
99
- ``init(name:parsing:help:completion:transform:)-2wf44``
10-
- ``init(wrappedValue:name:parsing:help:completion:)-7ilku``
10+
- ``init(name:parsing:help:completion:transform:)-25g7b``
1111
- ``init(wrappedValue:name:parsing:help:completion:transform:)-2llve``
1212
- ``SingleValueParsingStrategy``
1313

14+
@Comment {
15+
This gives a warning and doesn't show up here, but doesn't show up in the
16+
Initializers section, either. If I omit it here, then it shows up in the
17+
Initializers section.
18+
}
19+
20+
- ``init(wrappedValue:name:parsing:help:completion:)-7ilku``
21+
22+
@Comment {
23+
This gives a warning and doesn't show up here, but is in the Initializers
24+
section.
25+
}
26+
27+
- ``init(wrappedvalue:name:parsing:help:completion:)-7xcum``
28+
1429
### Array Options
1530

1631
- ``init(name:parsing:help:completion:)-238hg``
@@ -21,10 +36,17 @@
2136

2237
### Infrequently Used APIs
2338

24-
- ``init()``
2539
- ``init(from:)``
2640
- ``wrappedValue``
2741

2842
### Deprecated APIs
2943

3044
- ``init(wrappedValue:name:parsing:completion:help:)``
45+
46+
@Comment {
47+
These give a warning and don't show up here, but are in the Initializers
48+
section.
49+
}
50+
51+
- ``init(wrappedvalue:name:parsing:help:completion:)-4pl7h``
52+
- ``init(wrappedvalue:name:parsing:help:completion:transform:)-6rqji``

Sources/ArgumentParser/Documentation.docc/Extensions/OptionGroup.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
### Creating an Option Group
66

7-
- ``init(visibility:)``
7+
- ``init(title:visibility:)``
8+
9+
### Option Group Properties
10+
11+
- ``title``
812

913
### Infrequently Used APIs
1014

Sources/ArgumentParser/Documentation.docc/Extensions/ParsableArguments.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@
3333
### Infrequently Used APIs
3434

3535
- ``init()``
36+
- ``helpMessage(columns:)``

Sources/ArgumentParser/Parsable Properties/Argument.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ extension Argument {
460460
Optional @Arguments with default values should be declared as non-Optional.
461461
""")
462462
public init<T>(
463-
wrappedValue: Optional<T>,
463+
wrappedValue _wrappedValue: Optional<T>,
464464
help: ArgumentHelp? = nil,
465465
completion: CompletionKind? = nil
466466
) where T: ExpressibleByArgument, Value == Optional<T> {
@@ -471,7 +471,7 @@ extension Argument {
471471
kind: .positional,
472472
help: help,
473473
parsingStrategy: .default,
474-
initial: wrappedValue,
474+
initial: _wrappedValue,
475475
completion: completion)
476476

477477
return ArgumentSet(arg)
@@ -541,7 +541,7 @@ extension Argument {
541541
Optional @Arguments with default values should be declared as non-Optional.
542542
""")
543543
public init<T>(
544-
wrappedValue: Optional<T>,
544+
wrappedValue _wrappedValue: Optional<T>,
545545
help: ArgumentHelp? = nil,
546546
completion: CompletionKind? = nil,
547547
transform: @escaping (String) throws -> T
@@ -554,7 +554,7 @@ extension Argument {
554554
help: help,
555555
parsingStrategy: .default,
556556
transform: transform,
557-
initial: wrappedValue,
557+
initial: _wrappedValue,
558558
completion: completion)
559559

560560
return ArgumentSet(arg)

Sources/ArgumentParser/Parsable Types/ParsableCommand.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ extension ParsableCommand {
8282
@_disfavoredOverload
8383
@available(*, deprecated, renamed: "helpMessage(for:includeHidden:columns:)")
8484
public static func helpMessage(
85-
for subcommand: ParsableCommand.Type,
85+
for _subcommand: ParsableCommand.Type,
8686
columns: Int? = nil
8787
) -> String {
88-
helpMessage(for: subcommand, includeHidden: false, columns: columns)
88+
helpMessage(for: _subcommand, includeHidden: false, columns: columns)
8989
}
9090

9191
/// Returns the text of the help screen for the given subcommand of this

0 commit comments

Comments
 (0)