Skip to content

Update inconsistent return type - #87

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

Update inconsistent return type#87
martinsoenen merged 1 commit into
xefi:mainfrom
MrYamous:fix-inconstant-return-type

Conversation

@MrYamous

@MrYamous MrYamous commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

In HasExtensions trait, the resolve method return Container but underlying addLocaleExtension and addExtension annotations are about Extension

Fix those docblocks to align with code

Summary by CodeRabbit

  • Documentation
    • Corrected PHPDoc return annotations for container-extension registration methods.
    • Improved API documentation accuracy without changing runtime behavior.

@coderabbitai

coderabbitai Bot commented Jul 10, 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: 79c0bc65-e4b0-4177-bdda-ef25aabfeecc

📥 Commits

Reviewing files that changed from the base of the PR and between 772724b and 87fb4c0.

📒 Files selected for processing (1)
  • src/Container/Traits/HasExtensions.php

📝 Walkthrough

Walkthrough

Updated the PHPDoc @return annotations for addExtension and addLocaleExtension to reference \Xefi\Faker\Container\Container. Runtime logic and method signatures remain unchanged.

Changes

Container extension documentation

Layer / File(s) Summary
Correct extension method return annotations
src/Container/Traits/HasExtensions.php
The addExtension and addLocaleExtension PHPDoc annotations now document the container 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 matches the PR’s docblock return-type alignment and is specific enough to convey the main change.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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 !

@martinsoenen
martinsoenen merged commit c292720 into xefi:main Jul 20, 2026
2 of 5 checks passed
@MrYamous
MrYamous deleted the fix-inconstant-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