improved docstrings

src/RootedTrees.jl

@@ -3,7 +3,7 @@ module RootedTrees
 
 using LinearAlgebra
 
-import Base: show, isless, ==, iterate
+import Base: show, isless, ==, iterate, copy
 
 
 export RootedTree, RootedTreeIterator
@@ -35,6 +35,8 @@ function RootedTree(level_sequence::AbstractVector)
 end
 #TODO: Validate rooted tree in constructor?
 
+copy(t::RootedTree) = RootedTree(copy(t.level_sequence))
+
 
 #  #function RootedTree(sequence::Vector{T}, valid::Bool)
 #  function RootedTree(sequence::Array{T,1})
@@ -114,15 +116,17 @@ Returns a new tree using the canonical representation of the rooted tree `t`,
 i.e. the one with lexicographically biggest level sequence.
 """
 function canonical_representation(t::RootedTree)
-  canonical_representation!(RootedTree(copy(t.level_sequence)))
+  canonical_representation!(copy(t))
 end
 
 
 
 """
     RootedTreeIterator{T<:Integer}
 
-Iterator over all rooted trees of given `order`.
+Iterator over all rooted trees of given `order`. The returned trees are views to
+an internal tree modified during the iteration. If the returned trees shall be
+stored or modified during the iteration, a `copy` has to be made.
 """
 struct RootedTreeIterator{T<:Integer}
   order::T