docs: fix source code comment accuracy issues - #229
Merged
Conversation
Fixed 8 documentation accuracy issues across the codebase: - LockmanComposableMacros.swift: Correct priority parameter type (priority: 100 → priority: .high(.exclusive)) - LockmanLogger.swift: Clarify build condition behavior description - LockmanInfo.swift: Add missing mode parameters in examples - LockmanCompositeAction.swift: Add missing mode parameter - LockmanCompositeInfo.swift: Add missing mode parameter - LockmanGroupCoordinatedAction.swift: Fix enum values (.leader(.none) → .leader(.emptyGroup)) - LockmanPriorityBasedAction.swift: Fix enum values (.high(.preferLater) → .high(.exclusive)) All issues were minor syntax corrections ensuring code examples in documentation comments match actual implementation APIs. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixed 8 documentation accuracy issues identified during comprehensive source code comment analysis across the entire Lockman codebase.
Changes
Priority Parameter Type Correction
priority: 100→priority: .high(.exclusive)Build Condition Description Clarification
Missing Required Parameters
modeparameters in initialization examples (2 locations)modeparameter in examplemodeparameter in exampleNon-existent Enum Value Corrections
.leader(.none)→.leader(.emptyGroup).high(.preferLater)→.high(.exclusive)Impact
All changes ensure code examples in documentation comments accurately reflect the actual implementation APIs, improving developer experience and preventing confusion.
🤖 Generated with Claude Code