Skip to content

Commit

Permalink
doc/interface: correct signature of size (#29094)
Browse files Browse the repository at this point in the history
  • Loading branch information
iblislin authored and ararslan committed Sep 8, 2018
1 parent fda953b commit 0c73ad1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/src/manual/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ to generically build upon those behaviors.
| `IteratorEltype(IterType)` | `HasEltype()` | Either `EltypeUnknown()` or `HasEltype()` as appropriate |
| `eltype(IterType)` | `Any` | The type of the first entry of the tuple returned by `iterate()` |
| `length(iter)` | (*undefined*) | The number of items, if known |
| `size(iter, [dim...])` | (*undefined*) | The number of items in each dimension, if known |
| `size(iter, [dim])` | (*undefined*) | The number of items in each dimension, if known |

| Value returned by `IteratorSize(IterType)` | Required Methods |
|:------------------------------------------ |:------------------------------------------ |
| `HasLength()` | [`length(iter)`](@ref) |
| `HasShape{N}()` | `length(iter)` and `size(iter, [dim...])` |
| `HasShape{N}()` | `length(iter)` and `size(iter, [dim])` |
| `IsInfinite()` | (*none*) |
| `SizeUnknown()` | (*none*) |

Expand Down

0 comments on commit 0c73ad1

Please sign in to comment.