Tweak the documentation and bump version to 0.6.2

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.6.2] -- 2023-12-21
+
+### Fixed
+
+- Backward compatibility: `Out_channel.output_string` --> `Stdlib.output_string`.
+
 ## [0.6.1] -- 2023-12-20
 
 Support for debugging infinite loops.

dune-project

@@ -15,7 +15,7 @@
 
 (documentation https://lukstafi.github.io/ppx_minidebug/ppx_minidebug)
 
-(version 0.6.1)
+(version 0.6.2)
 
 (package
  (name ppx_minidebug)

index.mld

@@ -65,6 +65,18 @@ module Debug_runtime = (val Minidebug_runtime.debug_html "debug.html")
 Similarly, [debug] and [debug_flushing] are configurable shorthands that default to logging to [stdout]
 (but accept a `~debug_ch` argument).
 
+{3 Debugging infinite loops}
+
+Computation can be optionally interruped using the [~max_nesting_depth] and [~max_num_children] settings.
+The first raises a failure when the nesting of logs exceeds the given threshold, the second raises
+a failure when the number of log entries under a single parent exceeds the threshold. E.g.:
+{[
+module Debug_runtime =
+  (val Minidebug_runtime.debug_html ~max_nesting_depth:20 ~max_num_children:50 "debug.html")
+]}
+
+The cutoff points are indicated in the logs.
+
 {2 VS Code suggestions}
 
 {3 Add / remove type annotations and visit files using {e VOCaml}}

ppx_minidebug.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "0.6.1"
+version: "0.6.2"
 synopsis: "Debug logs for selected functions and let-bindings"
 description:
   "A poor man's `ppx_debug` with formatted logs of let-bound values, function arguments and results."