add size to Important optional methods #17525
Merged
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
that should be in the commit message, it doesn't count if it's only in the PR description |
| :func:`start(iter) <start>` Returns the initial iteration state | ||
| :func:`next(iter, state) <next>` Returns the current item and the next state | ||
| :func:`done(iter, state) <done>` Tests if there are any items remaining | ||
| **Important optional methods** **Default definition** **Brief description** | ||
| :func:`eltype(IterType) <eltype>` ``Any`` The type the items returned by :func:`next` | ||
| :func:`length(iter) <length>` (*undefined*) The number of items, if known | ||
| :func:`size(iter, [dim...]) <size>` (*undefined*) The number of items in each dimensions, if known |
| ==================================================================== ================================== | ||
| `HasEltype()` :func:`eltype(IterType) <eltype>` | ||
| `EltypeUnknown()` (*none*) | ||
| ==================================================================== ================================== |
There was a problem hiding this comment.
you may need an extra blank line after the end of the table to avoid a sphinx error
mfasi
pushed a commit
to mfasi/julia
that referenced
this pull request
Sep 5, 2016
* add size to Important optional methods * More extensive tables explaining what methods are required by traits * fix typo [ci skip] * newlines cod reStructuredText likes them [ci skip]
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.
See e01dcf3#commitcomment-18331656
sizelike length should be present in the list of methods.[ci skip]