Skip to content

Update inconsistent phpdoc annotations#88

Merged
martinsoenen merged 1 commit into
xefi:mainfrom
MrYamous:fix-return-type
Jul 20, 2026
Merged

Update inconsistent phpdoc annotations#88
martinsoenen merged 1 commit into
xefi:mainfrom
MrYamous:fix-return-type

Conversation

@MrYamous

@MrYamous MrYamous commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Update some phpdoc annotations to align with code types

Summary by CodeRabbit

  • Documentation
    • Corrected PHPDoc parameter naming for improved clarity.
    • Updated the documented return type to accurately reflect the method’s boolean result.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c3502f1c-4d76-41a0-99b0-cd366f5892d7

📥 Commits

Reviewing files that changed from the base of the PR and between 772724b and 642d44b.

📒 Files selected for processing (2)
  • src/Container/Container.php
  • src/Strategies/ValidStrategy.php

📝 Walkthrough

Walkthrough

Corrects a container method’s PHPDoc parameter name and updates ValidStrategy::pass() documentation from object to bool. No runtime logic or public declarations changed.

Changes

PHPDoc Corrections

Layer / File(s) Summary
Correct PHPDoc annotations
src/Container/Container.php, src/Strategies/ValidStrategy.php
Updates the container parameter annotation to $containerMixinManifestPath and documents the strategy method’s boolean return type.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the PR’s main change: correcting inconsistent PHPDoc annotations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@martinsoenen

Copy link
Copy Markdown
Contributor

Thanks Matthieu !

@martinsoenen
martinsoenen merged commit d60f489 into xefi:main Jul 20, 2026
2 of 5 checks passed
@MrYamous
MrYamous deleted the fix-return-type branch July 20, 2026 10:21
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