Document sep in repr

Joseph-Edwards · Oct 22, 2024 · 997f229 · 997f229
1 parent bf8a220
commit 997f229
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/include/libsemigroups/ukkonen.hpp b/include/libsemigroups/ukkonen.hpp
@@ -2450,6 +2450,8 @@ namespace libsemigroups {
   //! Return a human readable representation of an Ukkonen::State object.
   //!
   //! \param st the Ukkonen::State object.
+  //! \param sep the string used to separate "Ukkonen" and "State" in the output
+  //! (defaults to "::").
   //!
   //! \returns A value of type std::string
   //!
@@ -2467,6 +2469,8 @@ namespace libsemigroups {
   //! Return a human readable representation of an Ukkonen::Node object.
   //!
   //! \param node the Ukkonen::Node object.
+  //! \param sep the string used to separate "Ukkonen" and "Node" in the output
+  //! (defaults to "::").
   //!
   //! \returns A value of type std::string
   //!