Fix comments and docstrings

Author: alexander-yakushev

README.md

@@ -89,4 +89,4 @@ library from Java for the details.
 jvm-hiccup-meter is distributed under the Eclipse Public License. See
 [LICENSE](LICENSE).
 
-Copyright 2018-2022 Alexander Yakushev
+Copyright 2018-2024 Alexander Yakushev

src/jvm_alloc_rate_meter/MeterThread.java

@@ -109,9 +109,9 @@ private BigInteger allocatedByAllThreads() {
         long[] ids = threadBean.getAllThreadIds();
         long[] allocatedBytes = threadBean.getThreadAllocatedBytes(ids);
         BigInteger result = BigInteger.ZERO;
-        // This is approach is not entirely correct because doesn't see the
+        // This approach is not entirely correct because it doesn't see the
         // allocation data from threads that died since the last iteration. Oh
-        // well, doing best effort.
+        // well, just making the best effort.
         for (long abytes : allocatedBytes)
             result = result.add(BigInteger.valueOf(abytes));
         return result;

src/jvm_alloc_rate_meter/core.clj

@@ -5,10 +5,10 @@
 (defn start-alloc-rate-meter
   "Start the allocation meter thread. It will measure the heap object allocation
   rate every `interval-ms` (1000 by default) and call `callback-fn` with the
-  allocation rate in bytes/sec. Note that the rate will not be reported every
-  `interval-ms` as the iterations that happen accross a GC cycle are discarded.
+  allocation rate in bytes/sec. Note that the rate might not be reported every
+  `interval-ms` as some iterations may not produce reliable data.
 
-  Returns a nullary function which when called terminates the measuring thread."
+  Returns a nullary function which terminates the measuring thread when invoked."
   [callback-fn & {:keys [interval-ms]}]
   (let [iw (MeterThread. (reify LongConsumer
                            (accept [_ v]