Skip to content

Commit 642c4f3

Browse files
authored
Add "Documentation coverage" GSoC project idea
1 parent 7694075 commit 642c4f3

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

gsoc2025/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,33 @@ Enhance Swift Testing's reporting of test results to the console/terminal. Consi
303303

304304
- [Stuart Montgomery](https://github.com/stmontgomery)
305305

306+
### Documentation coverage
307+
308+
**Project size**: 90 hours (small)
309+
310+
**Estimated difficulty**: Intermediate
311+
312+
**Recommended skills**
313+
314+
- Basic proficiency in Swift.
315+
316+
**Description**
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.
321+
322+
**Expected outcomes/benefits/deliverables**
323+
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.
327+
328+
**Potential mentors**
329+
330+
- [David Rönnqvist](https://github.com/d-ronnqvist)
331+
332+
306333
### Example project name
307334

308335
**Project size**: N hours

0 commit comments

Comments
 (0)