Update documentation style to use block comments for 3+ lines #5
Conversation
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
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR standardizes documentation comments across the codebase by converting triple-slash comments with 3 or more consecutive lines to block comment style, aligning with CorvidLabs documentation guidelines.
- Converts 5 multi-line documentation comments from
///to/** */block style - Maintains the project's established block comment format (no asterisk prefix on content lines)
- Preserves all comment content without modification
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Terminal+Input.swift | Converts function documentation for readKeyWithTimeout to block style |
| KittyImage.swift | Converts struct-level documentation for KittyImage to block style |
| ITerm2Image.swift | Converts struct-level documentation for ITerm2Image to block style |
| Terminal.swift | Converts function documentation for waitForInput to block style |
| Logger.swift | Converts function documentation for debugLog to block style |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
///lines to/** */block styleTest Plan
🤖 Generated with Claude Code