Update documentation style to use block comments for 3+ lines #1
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
Convert multiline /// doc comments to /** */ block style for the fleschReadingEase property in ReadabilityScore.swift. 🤖 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 updates the documentation style for multi-line comments (3+ lines) from triple-slash (///) format to block comment (/** */) format. The change is applied to the fleschReadingEase property documentation in ReadabilityScore.swift, which also converts the list items to proper Markdown format using dashes. Single-line and two-line /// comments throughout the codebase remain unchanged, as stated in the PR description.
Key Changes
- Converted 8-line
///documentation comment to/** */block style - Reformatted readability score ranges as Markdown list items (with
-prefix) - Maintained all documentation content and meaning
💡 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
///documentation comments (3+ lines) to/** */block stylefleschReadingEaseproperty inReadabilityScore.swift///comments remain unchangedTest plan
swift buildpasses successfully🤖 Generated with Claude Code