Skip to content

Commit 827604c

Browse files
author
Reed Es
committed
fixed incorrect docs
1 parent ee30544 commit 827604c

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Types scoped within `SimpleTree`:
4646

4747
- `func getChildren(excludeValues: ValueSet) -> [Node]`: Fetch the child nodes of the node. Optional list of values for children to be excluded, along with their progeny. Traversal is breadth-first.
4848

49-
- `func getChildren(maxDepth: Int, excludeValues: ValueSet) -> [Node]`: Fetch the child nodes of the node. Optional list of values for children to be excluded, along with their progeny. Traversal is depth-first, with optional limit.
49+
- `func getChildren(maxDepth: Int, excludeValues: ValueSet) -> [Node]`: Fetch the child nodes of the node. Optional list of values for children to be excluded, along with their progeny. Traversal is depth-first.
5050

5151
- `func getParent(excludeValues: ValueSet) -> Node?`: Return the immediate parent node, if any. Optional list of parent values to be excluded. A match will cause this function to return nil.
5252

@@ -70,7 +70,7 @@ Types scoped within `SimpleTree`:
7070

7171
- `func getChildValues(excludeValues: ValueSet) -> [T]`: Fetch the values of the child nodes. Optional list of values for children to be excluded, along with their progeny. Traversal is breadth-first.
7272

73-
- `func getChildValues(maxDepth: Int, excludeValues: ValueSet) -> [T]`: Fetch the values of the child nodes. Optional list of values for children to be excluded, along with their progeny. Traversal is depth-first, with optional limit.
73+
- `func getChildValues(maxDepth: Int, excludeValues: ValueSet) -> [T]`: Fetch the values of the child nodes. Optional list of values for children to be excluded, along with their progeny. Traversal is depth-first.
7474

7575
- `func getParentValue(excludeValues: ValueSet) -> T?`: Return the value of the immediate parent node, if any. Optional list of parent values to be excluded. A match will cause this function to return nil.
7676

Sources/SimpleTree.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ extension SimpleTree {
7676

7777
/// Fetch the child nodes of the node.
7878
/// Optional list of values for children to be excluded, along with their progeny.
79-
/// Traversal is depth-first, with optional limit.
79+
/// Traversal is depth-first.
8080
public func getChildren(maxDepth: Int, excludeValues: ValueSet = ValueSet()) -> [Node] {
8181
guard maxDepth > 0 else { return [] }
8282
var nodes = [Node]()
@@ -210,7 +210,7 @@ extension SimpleTree {
210210

211211
/// Fetch the values of the child nodes.
212212
/// Optional list of values for children to be excluded, along with their progeny.
213-
/// Traversal is depth-first, with optional limit.
213+
/// Traversal is depth-first.
214214
public func getChildValues(maxDepth: Int, excludeValues: ValueSet = ValueSet()) -> [T] {
215215
getChildren(maxDepth: maxDepth, excludeValues: excludeValues).map(\.value)
216216
}

0 commit comments

Comments
 (0)