Skip to content

Commit 3b9ca16

Browse files
d-ronnqvistktoso
andauthored
Add "Documentation coverage" GSoC project idea (#904)
Co-authored-by: Konrad `ktoso` Malawski <[email protected]>
1 parent 2061107 commit 3b9ca16

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

gsoc2025/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,32 @@ Beyond the markdown output, this plugin could be further improved by generating
330330

331331
- [David Rönnqvist](https://github.com/d-ronnqvist)
332332

333+
### Documentation coverage
334+
335+
**Project size**: 90 hours (small)
336+
337+
**Estimated difficulty**: Intermediate
338+
339+
**Recommended skills**
340+
341+
- Basic proficiency in Swift.
342+
343+
**Description**
344+
345+
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.
354+
355+
**Potential mentors**
356+
357+
- [David Rönnqvist](https://github.com/d-ronnqvist)
358+
333359
### Example project name
334360

335361
**Project size**: N hours

0 commit comments

Comments
 (0)