package-info StreamOverflowException additions

motinis · Jul 3, 2018 · 2431184 · 2431184
1 parent c09c5ff
commit 2431184
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/gr/james/sampling/package-info.java b/src/main/java/gr/james/sampling/package-info.java
@@ -44,7 +44,9 @@
  * <h4>Overflow</h4>
  * Related to the concept of precision, overflow refers to the situation where the precision has degraded into a
  * non-recurrent state that would prevent the algorithm from behaving consistently. In these cases the implementation
- * will throw {@link gr.james.sampling.StreamOverflowException} to indicate this state.
+ * will throw {@link gr.james.sampling.StreamOverflowException} to indicate this state. Algorithms that are not prone to
+ * precision degrading will never throw {@code StreamOverflowException} and are marked <em>ND</em> in the implementation
+ * table below.
  * <h3>Implementations</h3>
  * <table class="table" summary="">
  * <thead>