Skip to content

fix(docs): Clean up event documentation in FoxyEvents class.#120

Merged
terabytesoftw merged 2 commits intomainfrom
fix_mini_13
Jan 24, 2026
Merged

fix(docs): Clean up event documentation in FoxyEvents class.#120
terabytesoftw merged 2 commits intomainfrom
fix_mini_13

Conversation

@terabytesoftw
Copy link
Contributor

Pull Request

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

@terabytesoftw terabytesoftw added the bug Something isn't working label Jan 24, 2026
@codecov
Copy link

codecov bot commented Jan 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (65ffdab) to head (fda46ca).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##                main      #120   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       359       359           
===========================================
  Files             26        26           
  Lines            823       823           
===========================================
  Hits             823       823           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@coderabbitai
Copy link

coderabbitai bot commented Jan 24, 2026

Warning

Rate limit exceeded

@terabytesoftw has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9809e4d and fda46ca.

📒 Files selected for processing (1)
  • src/FoxyEvents.php
📝 Walkthrough

Walkthrough

This PR adds a changelog entry and cleans up event documentation in the FoxyEvents class by removing @Event annotations from PHPDoc blocks for three constants while preserving their values and functionality.

Changes

Cohort / File(s) Summary
Changelog Documentation
CHANGELOG.md
Added entry for Bug #120 documenting the event documentation cleanup in FoxyEvents class
FoxyEvents Class Documentation
src/FoxyEvents.php
Removed @Event annotation lines from PHPDoc blocks for GET_ASSETS, POST_SOLVE, and PRE_SOLVE constants; slightly rewording descriptions while keeping constant values unchanged

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

Estado: error

Poem

🐰 With whiskers twitching, I clean the docs with care,
Removing old annotations floating in the air,
Three constants shine brighter, free from @Event spam,
The FoxyEvents class thanks this helpful little jam! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: cleaning up event documentation in the FoxyEvents class, which aligns with the actual changes to PHPDoc blocks.
Description check ✅ Passed The description is related to the changeset by indicating it's a bugfix with no breaking changes, though minimal detail is provided.
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.


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 and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@src/FoxyEvents.php`:
- Around line 10-11: Update the docblock for the GET_ASSETS event in
FoxyEvents.php to fix the grammatical issue "and during the retrieves the map":
reword the sentence so it clearly states that the event is triggered before the
`solve` action of asset packages and is responsible for retrieving the map of
asset packages (e.g., "The `GET_ASSETS` event is triggered before the `solve`
action of asset packages and is used to retrieve the map of asset packages.").
Ensure the updated sentence replaces the current malformed phrase in the
GET_ASSETS description.
📜 Review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65ffdab and 9809e4d.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • src/FoxyEvents.php
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: terabytesoftw
Repo: php-forge/foxy PR: 115
File: tests/Fallback/AssetFallbackTest.php:158-189
Timestamp: 2026-01-23T11:22:07.261Z
Learning: User terabytesoftw prefers not to use aliases when importing classes in PHP. They are comfortable with either fully-qualified class names or direct imports without aliases.
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.

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

@terabytesoftw terabytesoftw merged commit f9dc1fc into main Jan 24, 2026
48 checks passed
@terabytesoftw terabytesoftw deleted the fix_mini_13 branch January 24, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant