Skip to content

Commit c216c8a

Browse files
committed
small docs update
1 parent b21e444 commit c216c8a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/cursors.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ Abstract type for tree cursors which when constructed from a node can be used to
1616
navigate the entire tree descended from that node.
1717
1818
Tree cursors satisfy the abstract tree interface with a few additional guarantees:
19-
- Tree cursors always define [`children`](@ref), [`parent`](@ref) and [`nextsibling`](@ref).
20-
[`prevsibling`](@ref) may be defined depending on whether it is defined for the wrapped tree.
21-
- The above functions returning tree nodes are guaranteed to also return tree cursors.
19+
- Tree cursors all have the [`StoredParents`](@ref) and [`StoredSiblings`](@ref) traits.
20+
- All functions acting on a cursor which returns a tree node is guaranteed to return another `TreeCursor`.
21+
For example, `children`, `parent` and `nextsiblin` all return a `TreeCursor` of the same type as
22+
the argument.
2223
2324
Tree nodes which define `children` and have the traits [`StoredParents`](@ref) and
2425
[`StoredSiblings`](@ref) satisfy the `TreeCursor` interface, but calling `TreeCursor(node)` on such

src/iteration.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,3 +480,4 @@ MapNode{Nothing, MapNode}(nothing)
480480
```
481481
"""
482482
treemap(f, node) = MapNode(f, node)
483+

0 commit comments

Comments
 (0)