From 87e623db850b8839d9c31a2098a75fe227d4c064 Mon Sep 17 00:00:00 2001 From: Pierre Janineh Date: Sun, 31 May 2026 18:45:56 +0300 Subject: [PATCH 1/2] docs: fix DocC symbol-link warnings across public API Documentation audit cleanup: - Convert non-symbol tokens (progressLineWidth, progressInnerLineWidth, radius) in the size tables from `` ``symbol`` `` links to plain code spans in Options.size and setSize(_:). - Close the malformed ``GrowDirection/end`` links (were missing trailing backticks) in Options.growFrom and setGrow(from:). - Fix the setGrow `- Parameter from:` -> `direction:` external-name mismatch. DocC now builds with 0 warnings. Co-Authored-By: Claude Opus 4.8 (1M context) --- .../Components/ProgressUI/ProgressUI+Modifiers.swift | 8 ++++---- Sources/ProgressUI/Options.swift | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Sources/ProgressUI/Components/ProgressUI/ProgressUI+Modifiers.swift b/Sources/ProgressUI/Components/ProgressUI/ProgressUI+Modifiers.swift index 7d1775f..d489a0a 100644 --- a/Sources/ProgressUI/Components/ProgressUI/ProgressUI+Modifiers.swift +++ b/Sources/ProgressUI/Components/ProgressUI/ProgressUI+Modifiers.swift @@ -14,9 +14,9 @@ extension ProgressUI { /// /// Default: ``ProgressSize/large``. /// - /// ``ProgressSize/large`` > ``trackWidth`` `= 45`, ``progressLineWidth`` `= 10`, ``progressInnerLineWidth`` `= 5`, ``radius`` `= 60` + /// ``ProgressSize/large`` > `trackWidth = 45`, `progressLineWidth = 10`, `progressInnerLineWidth = 5`, `radius = 60` /// - /// ``ProgressSize/small`` > ``trackWidth`` = `15`, ``progressLineWidth`` `= 5`, ``progressInnerLineWidth`` `= 2.5`, ``radius`` `= 30` + /// ``ProgressSize/small`` > `trackWidth = 15`, `progressLineWidth = 5`, `progressInnerLineWidth = 2.5`, `radius = 30` public func setSize(_ size: ProgressSize) -> Self { var copy = self copy.options.size = size @@ -129,10 +129,10 @@ extension ProgressUI { } /// Sets the direction the progress arc growth. - /// - Parameter from: Growing animation direction (default: .end). + /// - Parameter direction: Growing animation direction (default: .end). /// - Returns: A modified ProgressUI instance. /// - /// Default: ``ProgressUI/GrowDirection/end. + /// Default: ``GrowDirection/end``. /// /// > Setting this value to ``ProgressUI/GrowDirection/center`` with rotation public func setGrow(from direction: GrowDirection = .end) -> Self { diff --git a/Sources/ProgressUI/Options.swift b/Sources/ProgressUI/Options.swift index 56fc204..5841a5b 100644 --- a/Sources/ProgressUI/Options.swift +++ b/Sources/ProgressUI/Options.swift @@ -68,9 +68,9 @@ public struct Options { Default: ``ProgressSize/large``. - ``ProgressSize/large`` > ``trackWidth`` `= 45`, ``progressLineWidth`` `= 10`, ``progressInnerLineWidth`` `= 5`, ``radius`` `= 60` - - ``ProgressSize/small`` > ``trackWidth`` = `15`, ``progressLineWidth`` `= 5`, ``progressInnerLineWidth`` `= 2.5`, ``radius`` `= 30` + ``ProgressSize/large`` > `trackWidth = 45`, `progressLineWidth = 10`, `progressInnerLineWidth = 5`, `radius = 60` + + ``ProgressSize/small`` > `trackWidth = 15`, `progressLineWidth = 5`, `progressInnerLineWidth = 2.5`, `radius = 30` > You can set this with the modifier ``ProgressUI/ProgressUI/setSize(_:)``. */ @@ -160,7 +160,7 @@ public struct Options { /** Determines where the growing animation should go. - Default: ``ProgressUI/GrowDirection/end. + Default: ``GrowDirection/end``. > You can set this with the modifier ``ProgressUI/ProgressUI/setGrow(from:)``. */ From 7224dcc877582826a419c8a7d632a3b29b67178b Mon Sep 17 00:00:00 2001 From: Pierre Janineh Date: Sun, 31 May 2026 18:48:31 +0300 Subject: [PATCH 2/2] docs: finalize CHANGELOG for 1.1.0 Promote [Unreleased] -> [1.1.0] (2026-05-31), add the DocC warning fix and the workflow-permissions security entry, and add version compare links. Co-Authored-By: Claude Opus 4.8 (1M context) --- CHANGELOG.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5634f72..289054c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,8 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [1.1.0] - 2026-05-31 + ### Added -- Public memberwise initializer for ``Options``, allowing consumers to construct +- Public memberwise initializer for `Options`, allowing consumers to construct a configuration directly (e.g. `Options(progressColor: .blue)`) instead of only through the `set…` modifiers. - Unit test target (`ProgressUITests`) covering `Options` defaults, the new @@ -27,3 +29,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Corrected the README "Dynamic Colors" and "Customization Options" examples, which previously did not compile. +- Resolved DocC symbol-link warnings in the `Options.size`/`setSize(_:)` size + tables and the `GrowDirection.end` default links; DocC now builds cleanly. + +### Security +- Set a least-privilege `GITHUB_TOKEN` (`contents: read`) on the Build & Test + workflow, resolving the CodeQL `actions/missing-workflow-permissions` alerts. + +[Unreleased]: https://github.com/PierreJanineh-com/ProgressUI/compare/1.1.0...HEAD +[1.1.0]: https://github.com/PierreJanineh-com/ProgressUI/compare/1.0.4...1.1.0