Document IndexOutOfBoundsException on List::removeAt() - #48
Merged
Merged
Conversation
removeAt() declared @throws OutOfBoundsException (the SPL class), but every implementation raises Noctud\Collection\Exception\IndexOutOfBoundsException, which extends LogicException - so a catch written against the docblock never matched. Correct the declaration on ImmutableList and WritableList, regenerate the narrowed interfaces that copy it, drop the now unused imports, and fix the same mistake in the List API docs.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
removeAt() declared @throws OutOfBoundsException, the SPL class, but every implementation raises Noctud\Collection\Exception\IndexOutOfBoundsException, which extends LogicException rather than it. A catch written against the docblock never matched.
Correct the declaration on ImmutableList and WritableList, and regenerate WritableTrackedList, MutableList and MutableTrackedList, whose narrowed removeAt() docblocks are copied from WritableList. The generator does not manage use statements, so the now unused OutOfBoundsException imports are removed by hand. The List API docs carried the same mistake and are fixed too.
Docblocks and docs only, no behavior change. The existing removeAt_throws_on_invalid_index test already asserts IndexOutOfBoundsException.