docs

joshday · Oct 5, 2021 · b4e4881 · b4e4881
1 parent f1162f7
commit b4e4881
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/wrappers.jl b/src/wrappers.jl
@@ -89,9 +89,10 @@ Base.skipmissing(o::OnlineStat) = SkipMissing(o)
 """
     TryCatch(stat; error_limit=1000, error_message_limit=90)
 
-Wrap each call to `fit!` in a `try`-`catch` block and track the errors encountered (via [`CountMap`](@ref)).  Errors will stop
-being tracked after `error_limit` unique errors are encountered.  Only the first `error_message_limit`
-characters of each error message will be recorded.
+Wrap each call to `fit!` in a `try`-`catch` block and track the errors encountered (via [`CountMap`](@ref)).  
+Only `error_limit` unique errors will be included in the `CountMap`.  If a new error occurs after 
+`error_limit` has been reached, it will be included in the `CountMap` as `"Other"`.  Only the first 
+`error_message_limit` characters of each error message will be recorded.
 
 # Example