Add internal docs for metadata and array behind Extended help wrappers #694
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 adds docstrings to internal functions in metadata and array which are hidden behind an
Extended help
layer. The idea is to provide the docstring, but to make clear that the functions are internal.The docstrings could clearly be improved, they are based on my current understanding from reading the code.
If you like the overall look of this, I might be going through more of the internal functions in the next weeks to add more internal documentation.
I also added docstrings to
DimVector
and similar types following the docstring examples for AbstractVector.In the REPL this would look like this for internal functions: