fix(docs): Clarify parameter descriptions in Message::getMessage() method in Message enum.

[terabytesoftw]

Pull Request

Q	A
Is bugfix?	✔️
New feature?	❌
Breaks BC?	❌

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Enhanced error message documentation by clarifying parameter type specifications and improving return value descriptions for better developer reference.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Two documentation-only updates were made: a new changelog entry for Bug #15 was added, and the docblock comments for the Message::getMessage() method were clarified to better describe the parameter type and return value. No functional changes to code or public API.

Changes

Cohort / File(s)	Summary
Changelog Update CHANGELOG.md	Added entry documenting Bug #15 regarding clarified parameter descriptions in Message::getMessage()
Documentation Update src/Exception/Message.php	Updated docblock for getMessage() method: specified variadic parameter type and value, refined return description from "Error message with interpolated arguments." to "Formatted error message with interpolated arguments."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog entry hops in with care,
Docblock words now crystal and fair,
No code changed, just clarity's touch,
Messages formatted—oh, how we love much! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: clarifying parameter descriptions in the Message::getMessage() method, which matches the documentation updates in the changeset.
Description check	✅ Passed	The description is related to the changeset, clearly stating this is a bugfix that updates documentation without breaking BC or adding features.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 003f7ee and 20767d0.

📒 Files selected for processing (2)

• CHANGELOG.md
• src/Exception/Message.php

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: terabytesoftw
Repo: php-forge/support PR: 12
File: src/TestSupport.php:0-0
Timestamp: 2025-08-18T20:13:33.518Z
Learning: User terabytesoftw prefers clean trait-based designs over maintaining backward compatibility wrappers when refactoring utility classes in the php-forge/support project.

Learnt from: terabytesoftw
Repo: php-forge/actions PR: 65
File: .github/workflows/composer-require-checker.yml:80-83
Timestamp: 2025-09-28T15:12:48.345Z
Learning: The user terabytesoftw prefers using floating tags like v1 for third-party actions in GitHub workflows instead of pinning to specific commit SHAs, even when it's a security best practice to pin to immutable commits.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: linter / Super Linter
• GitHub Check: linter / Super Linter

🔇 Additional comments (2)

CHANGELOG.md (1)

6-6: LGTM!

The changelog entry accurately describes the documentation improvement and follows the project's changelog format consistently.

src/Exception/Message.php (1)

44-46: LGTM!

The docblock improvements enhance clarity:

• The parameter description now explicitly states the purpose of the variadic arguments
• The return description more accurately reflects that the message is formatted via sprintf()

These documentation refinements make the method's contract clearer without any functional changes.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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