Tweak docs, add tests for extension interface #1825
Conversation
This file contains 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
This makes minor documentaion changes that show users how to extend the interface without generating ambiguities or StackOverflowErrors.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1825 +/- ##
==========================================
+ Coverage 85.94% 85.95% +0.01%
==========================================
Files 144 144
Lines 8658 8658
==========================================
+ Hits 7441 7442 +1
+ Misses 1217 1216 -1 ☔ View full report in Codecov by Sentry. |
|
@devmotion @andreasnoack Perhaps this is worth a look to review and merge? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes minor documentaion changes that show
users how to extend the interface without generating
ambiguities or StackOverflowErrors.
It turns out to be important to ensure that one's methods "win" specificity, otherwise it's pretty easy to get StackOverflowErrors. In particular,
AbstractArrayoften isn't sufficient, it often needs to be{<:Real}and/or of specific dimensionality.Note that a few are
@test_broken, despite following the documentation. These could be fixed during review or in a follow-up PR.