Skip to content

Conversation

@0xLeif
Copy link
Contributor

@0xLeif 0xLeif commented Jan 5, 2026

Summary

  • Converts documentation comments with 3+ consecutive /// lines to /** */ block style
  • Files updated: AnyValidator.swift, Validator.swift, NotValidator.swift, OrValidator.swift, AndValidator.swift, Validatable.swift, PropertyValidator.swift
  • Maintains consistency with CorvidLabs documentation style guidelines

Test Plan

  • Build passes locally
  • No functional changes

🤖 Generated with Claude Code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request converts documentation comments from triple-slash (///) style to block comment (/** */) style for comments spanning 3 or more lines, aligning with CorvidLabs documentation style guidelines. This is a documentation-only change with no functional impact.

Key Changes

  • Converts all multi-line (3+) triple-slash comments to block comment format across 7 Swift files
  • Maintains proper Swift documentation formatting including blank lines and parameter documentation
  • Preserves all documentation content without modification

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Sources/Valid/Schema/Validatable.swift Updated protocol documentation from /// to /** */ block style
Sources/Valid/Schema/PropertyValidator.swift Converted struct and helper documentation to block comments (2 locations)
Sources/Valid/Core/Validator.swift Updated protocol and method documentation to block style (2 locations)
Sources/Valid/Core/AnyValidator.swift Converted type-erased validator struct documentation to block comment
Sources/Valid/Composition/OrValidator.swift Updated OR validator struct documentation to block style
Sources/Valid/Composition/NotValidator.swift Converted NOT validator struct documentation to block comment
Sources/Valid/Composition/AndValidator.swift Updated AND validator struct documentation to block style

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

/// - Returns: A type-erased validator.
/**
Type-erases this validator.

Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation in the block comment. Line 70 has inconsistent spacing compared to line 69 and line 71. The content line should be indented with one space after the asterisk to align with line 69, and the Returns parameter should also have consistent indentation.

Suggested change

Copilot uses AI. Check for mistakes.
@0xLeif 0xLeif merged commit 648636e into main Jan 5, 2026
8 checks passed
@0xLeif 0xLeif deleted the fix/documentation-style branch January 5, 2026 23:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants