AbstractBlockArray documentation enhancement#456
Draft
kunzaatko wants to merge 3 commits intoJuliaArrays:masterfrom
Draft
AbstractBlockArray documentation enhancement#456kunzaatko wants to merge 3 commits intoJuliaArrays:masterfrom
AbstractBlockArray documentation enhancement#456kunzaatko wants to merge 3 commits intoJuliaArrays:masterfrom
Conversation
Member
|
This seems pretty useful to me. Please proceed with a draft, and we may iterate on the details. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #456 +/- ##
===========================================
+ Coverage 0.00% 93.62% +93.62%
===========================================
Files 18 19 +1
Lines 1642 1664 +22
===========================================
+ Hits 0 1558 +1558
+ Misses 1642 106 -1536 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Recently I wanted to implement the
AbstractBlockArrayinterface for a custom array. I took a look at the documentation, but it does not provide sufficient instructions for the user to provide the correct method implementations.This PR should serve as an attempt to improve this. The template documentation should be the
AbstractArrayinterface in the standard library. This consists of two features:The current commits only fix some obvious issues with the documentation and the docstrings which bring it closer to the standard library documentation and docstrings of the
AbstractArraytypes. These should be non-controversial. It is only a draft, since the documentation of the interface needs a greater overhaul and this should provide a place todiscuss the options for this. Should I proceed in giving it a try or do you have other intentions with the documentation @jishnub? I want to assure myself before doing work that might be useless...