Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add missing exception annotations #1050

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Conversation

asteragos
Copy link
Contributor

This PR adds missing @throws annotations to method doc blocks in the AbstractProvider class, ensuring all thrown exceptions are properly documented.

Related Issue
Fixes Issue #880 by improving PHPDoc accuracy, enhancing developer experience, and supporting static analysis tools.

Changes
Added @throws annotations for all undocumented exceptions in method doc blocks.
Verified annotations match the exceptions thrown.

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2455200) to head (d47f6c6).
Report is 33 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##              master     #1050   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       191       193    +2     
===========================================
  Files             20        20           
  Lines            516       521    +5     
===========================================
+ Hits             516       521    +5     
Files with missing lines Coverage Δ
src/Provider/AbstractProvider.php 100.00% <ø> (ø)

@ramsey
Copy link
Contributor

ramsey commented Dec 18, 2024

Thank you for contributing! 🎉

@ramsey ramsey merged commit 8dc01b2 into thephpleague:master Dec 18, 2024
26 checks passed
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.

AbstractProvider - unexpected, undocumented exceptions
2 participants