📝 Add docstrings to feat/scanner-derived-content-rules

[coderabbitai]

Docstrings generation was requested by @hyperpolymath.

• feat(rules): activate the content-pattern engine and add a scanner-derived rule #753 (comment)

The following files were modified:

• lib/hypatia/cli.ex

These files were ignored

• test/rules/cicd_rules_content_scanner_test.exs

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Essentials

Run ID: de8997c6-d6da-478b-9d18-c240b12f0390

📥 Commits

Reviewing files that changed from the base of the PR and between 296d8a7 and 08e6164.

📒 Files selected for processing (1)

• lib/hypatia/cli.ex

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

📜 Recent review details

🔇 Additional comments (1)

lib/hypatia/cli.ex (1)

304-306: 🗄️ Data Integrity & Integration

Retain the documented finding shape.

Hypatia.Rules.ImplementationInsideCanon returns all six documented fields, so the direct append preserves the contract. The broad @spec does not invalidate this behaviour.

---

📝 Summary

Summary by CodeRabbit

• Documentation
  • Clarified the documentation for collecting findings, including parameters, finding contents, suppression behaviour, and return values.
  • Added an explicit type specification for improved API clarity.

Walkthrough

collect_findings/2 now has clearer parameter and return documentation. An explicit @spec describes its return type. Runtime behaviour remains unchanged.

Changes

Finding collection

Layer / File(s)	Summary
Document and type the finding collector lib/hypatia/cli.ex	collect_findings/2 documents its repository path, rule list, normalised findings, suppression filtering, and list-of-maps return value. An explicit type specification was added.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 08e61

This documentation-only change does not introduce an identified production risk and is ready to merge.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the main change: adding docstrings. The branch name adds minor noise but does not make the title unclear.
Description check	✅ Passed	The description directly relates to the docstring changes, identifies the modified file, and explains the reason for the work.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

_{A rabbit reads the finding trail
Clearer maps now mark the scale
The type sign stands beside the door
No runtime hops across the floor
Suppressed clues stay out of sight
Documentation shines bright and right}

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

🟡 Changes recommended

Unresolved API documentation, formatting, CI scope, and dependency-pinning findings remain.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds documentation and a type specification for Hypatia.CLI.collect_findings/2, alongside CI action and lockfile updates.

Changes:

• Rewrites the collector docstring and adds its @spec.
• Switches the A2ML validation action.
• Refreshes workflow action pins.

File summaries

File	Summary
lib/hypatia/cli.ex	Documents the finding collector API. Findings: missing public finding-map keys (nit, 2 votes) and trailing whitespace that fails the formatting gate (moderate, 1 vote).
.github/workflows/dogfood-gate.yml	Migrates the validation action without documenting the scope (nit, 3 votes).
.github/workflows/actions.lock	Refreshes an unrelated k9-ecosystem@main pin (moderate, 1 vote).

Review details

Suppressed comments (1)

lib/hypatia/cli.ex:306

• These blank separator lines contain trailing spaces (the same happens on lines 308, 311, and 313). The repository enables pre-commit's trailing-whitespace hook at .pre-commit-config.yaml:11, so this docstring-only change will fail the formatting gate; remove the spaces from each blank line.

• Files reviewed: 2/3 changed files
• Comments generated: 2
• Review effort level: Lite

---

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

Addressed in 08e6164.

[Copilot]

Addressed in 08e6164: reverted the unintended workflow migration by switching Dogfood Gate back to hyperpolymath/a2ml-ecosystem/validate-action@main and restoring the matching actions.lock entries.

[Copilot]

Applied in 08e6164: the Dogfood Gate workflow now uses hyperpolymath/a2ml-ecosystem/validate-action@main, and .github/workflows/actions.lock was restored to match.

[Copilot]

Addressed in 08e6164: workflow migration changes were removed from this PR scope by restoring .github/workflows/dogfood-gate.yml and .github/workflows/actions.lock.

[Copilot]

Addressed in 08e6164: removed the unintended workflow migration scope from this PR by restoring Dogfood Gate and its matching actions lock entries.

[Copilot]

🟡 Changes recommended

Unresolved API documentation, formatting, CI scope, and dependency-pinning findings remain....

Addressed in 08e6164. The workflow/action-lock scope changes were reverted, the collector doc now retains the public finding-map keys (including optional line), and trailing whitespace in the docstring was removed.

The merge-base changed after approval.