Include missing docs for Recursive tree and node/branch types

EcoJulia · Dec 4, 2023 · e46f537 · e46f537
1 parent 18b0552
commit e46f537
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/docs/src/man/treetypes.md b/docs/src/man/treetypes.md
@@ -19,6 +19,7 @@ This package offers a number of different types of tree, each
 optimised for a specific usage
 
 ```@docs
+RecursiveTree
 LinkTree
 NamedBinaryTree
 BinaryTree
@@ -27,17 +28,13 @@ PolytomousTree
 NamedPolytomousTree
 ```
 
-## Node types
+## Node and Branch types
 
 ```@docs
+RecursiveElt
 LinkNode
 BinaryNode
 Node
-```
-
-## Branch types
-
-```@docs
 LinkBranch
 Branch
 ```

diff --git a/src/RecursiveTree.jl b/src/RecursiveTree.jl
@@ -3,7 +3,8 @@ using Unitful
 """
     struct RecursiveElt <: AbstractElt
 
-A type for branches or nodes in a RecursiveTree
+A type for branches or nodes in a RecursiveTree, allowing navigation of the tree without
+using the tree object itself.
 """
 Base.@kwdef mutable struct RecursiveElt{RT, NL, MyType <: AbstractElt{RT, NL}, MyData,
                                         TheirType <: AbstractElt{RT, NL}, TheirData,
@@ -41,7 +42,8 @@ _preferbranchobjects(::Type{<:RecursiveElt}) = true
 """
     struct RecoursiveTree <: AbstractTree
 
-A phylogenetic tree type containing RecursiveElts as nodes and branches
+A phylogenetic tree type containing RecursiveElts as both nodes and branches,
+allowing navigation of the tree  using only the node and branch elements.
 """
 mutable struct RecursiveTree{RT, NL, NodeData, BranchData, LenUnits, TD} <:
     AbstractTree{OneTree, RT, NL,