From 12ff984c07370e61d86b3bba4ca1ea06febc7bd0 Mon Sep 17 00:00:00 2001
From: Josh Ziegler <josh@pylon.com>
Date: Mon, 18 Oct 2021 17:09:09 -0400
Subject: [PATCH] update Android ASR javadoc

---
 .../spokestack/android/AndroidSpeechRecognizer.java      | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/main/java/io/spokestack/spokestack/android/AndroidSpeechRecognizer.java b/src/main/java/io/spokestack/spokestack/android/AndroidSpeechRecognizer.java
index 5808524..7b4c254 100644
--- a/src/main/java/io/spokestack/spokestack/android/AndroidSpeechRecognizer.java
+++ b/src/main/java/io/spokestack/spokestack/android/AndroidSpeechRecognizer.java
@@ -64,10 +64,17 @@
  * <ul>
  *   <li>
  *      <b>wake-active-min</b> (integer): the minimum length of time, in
- *      milliseconds, that the recognizer will wait for speech before timing
+ *      milliseconds, that the recognizer should wait for speech before timing
  *      out.
  *   </li>
  * </ul>
+ *
+ * <p>
+ * The {@code wake-active-min} parameter merely sets a hint for the
+ * {@code Intent} used to start recognition, and Google
+ * <a href="https://developer.android.com/reference/android/speech/RecognizerIntent#EXTRA_SPEECH_INPUT_MINIMUM_LENGTH_MILLIS">
+ * does not guarantee</a> that this hint will be honored on all devices.
+ * </p>
  */
 public class AndroidSpeechRecognizer implements SpeechProcessor {
     private final int minActive;