From 642c4f3ef41579abb330c3a41690e40c5c17b7b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20R=C3=B6nnqvist?= Date: Tue, 11 Feb 2025 19:09:02 +0100 Subject: [PATCH] Add "Documentation coverage" GSoC project idea --- gsoc2025/index.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/gsoc2025/index.md b/gsoc2025/index.md index 9ddd4184c..d497eb4f0 100644 --- a/gsoc2025/index.md +++ b/gsoc2025/index.md @@ -303,6 +303,33 @@ Enhance Swift Testing's reporting of test results to the console/terminal. Consi - [Stuart Montgomery](https://github.com/stmontgomery) +### Documentation coverage + +**Project size**: 90 hours (small) + +**Estimated difficulty**: Intermediate + +**Recommended skills** + +- Basic proficiency in Swift. + +**Description** + +Enhance Swift DocC's experimental documentation coverage feature to write coverage metrics in a new extensible format that other tools can read and display. +Define a few types of metrics—for example Boolean (has documentation: true/false), Fraction (2/3 parameters are documented), Percentage, etc.—for this format. +Explore ideas for what documentation coverage information would be useful to emit. Explore ideas for how another tool could display that coverage information. + +**Expected outcomes/benefits/deliverables** + +- Land the documentation coverage output format changes for the experimental feature in DocC. +- Submit a pitch to the community and the Documentation Workgroup to formally enable the documentation coverage feature in DocC. +- Summarize your effort with a demo of the new metrics and examples of how another tool could display that information. + +**Potential mentors** + +- [David Rönnqvist](https://github.com/d-ronnqvist) + + ### Example project name **Project size**: N hours