Documentation

utahplt · Jun 2, 2023 · 510daf2 · 510daf2
1 parent 8028690
commit 510daf2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ We strive to follow [SemVer](https://semver.org/) conventions. Per [item 4 in th
 
 That said, this is research software, so expect some instability as we aim first and foremost to push the boundaries of what is possible.
 
+## 0.3.0
+
+### Added
+
+Event limit in logger works: set `maxLogs` to control how many events get logged. FloatTracker stops collecting stack traces after this, so should run much faster once the threshold has been hit. Defaults to `Unbounded()`.
+
 ## 0.2.0
 
 ### Added

diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ Keyword arguments for `config_logger`:
 
  - `maxFrames::Union{Int,Unbounded}` Maximum number of frames to print per even in the logs; defaults to `Unbounded`.
 
- - `maxLogs::Union{Int,Unbounded}` (Unimplemented as of 0.2.0) Maximum number of events to log; defaults to `Unbounded`.
+ - `maxLogs::Union{Int,Unbounded}` Maximum number of events to log; defaults to `Unbounded`.
 
  - `exclusions::Array{Symbol}` Events to not log; defaults to `[:prop]`.