AbstractBlockArray
documentation enhancement
#456
Draft
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
AbstractBlockArray
interface 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
AbstractArray
interface 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
AbstractArray
types. 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...