You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -315,20 +315,46 @@ Enhance Swift Testing's reporting of test results to the console/terminal. Consi
315
315
316
316
**Description**
317
317
318
-
Enhance Swift DocC's experimental documentation coverage feature to write coverage metrics in a new extensible format that other tools can read and display.
319
-
Define a few types of metrics—for example Boolean (has documentation: true/false), Fraction (2/3 parameters are documented), Percentage, etc.—for this format.
320
-
Explore ideas for what documentation coverage information would be useful to emit. Explore ideas for how another tool could display that coverage information.
318
+
Swift Argument Parser recently added a [command plugin](https://github.com/apple/swift-argument-parser/pull/694) to generate documentation markup for a command line tool.
319
+
This plugin could be improved by providing support for generating separate pages for each command and by leveraging additional markdown syntax to organize command line flags into sections and display possible values and default values.
320
+
321
+
Beyond the markdown output, this plugin could be further improved by generating a ["symbol graph"](https://github.com/swiftlang/swift-docc-symbolkit/tree/main) that describe each command and its flags, options, and subcommands. By describing the commands' structure, tools like [Swift DocC](https://github.com/swiftlang/swift-docc/tree/main) can further customize the display of command line tool documentation, support links to individual flags, and allow developers to extend or override the documentation for individual flags in ways that isn't overwritten when regenerating the documentation markup from the plugin. If time allows, prototype some enhancement to command line documentation in Swift DocC that leverage the information from the command symbol graph file.
321
322
322
323
**Expected outcomes/benefits/deliverables**
323
324
324
-
-Land the documentation coverage output format changes for the experimental feature in DocC.
325
-
-Submit a pitch to the community and the Documentation Workgroup to formally enable the documentation coverage feature in DocC.
326
-
-Summarize your effort with a demo of the new metrics and examples of how another tool could display that information.
325
+
-A richer markdown output from the plugin.
326
+
-Support for generating separate pages for each command.
327
+
-Output a supplementary symbol graph file that describe the commands' structure.
Enhance Swift DocC's experimental documentation coverage feature to write coverage metrics in a new extensible format that other tools can read and display.
346
+
Define a few types of metrics—for example Boolean (has documentation: true/false), Fraction (2/3 parameters are documented), Percentage, etc.—for this format.
347
+
Explore ideas for what documentation coverage information would be useful to emit. Explore ideas for how another tool could display that coverage information.
348
+
349
+
**Expected outcomes/benefits/deliverables**
350
+
351
+
- Land the documentation coverage output format changes for the experimental feature in DocC.
352
+
- Submit a pitch to the community and the Documentation Workgroup to formally enable the documentation coverage feature in DocC.
353
+
- Summarize your effort with a demo of the new metrics and examples of how another tool could display that information.
Copy file name to clipboardExpand all lines: index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ atom: true
17
17
</div>
18
18
19
19
<divclass="banner primary">
20
-
<p>Get ready for the Swift 6 language mode with the <ahref="https://www.swift.org/migration/">official migration guide</a></p>
20
+
<p>Swift 6 is here! Learn about the new language mode with the <ahref="https://www.swift.org/migration/documentation/migrationguide/">official migration guide</a>.</p>
0 commit comments