From d2aa7e9e3724b459167adf78bcba2334b73eb28e Mon Sep 17 00:00:00 2001
From: Felix Hamann <felix.hamann@campus.lmu.de>
Date: Tue, 23 Apr 2019 22:00:33 +0200
Subject: [PATCH] update documentation for mass input js util

---
 static/js/utils/massInput.js | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/static/js/utils/massInput.js b/static/js/utils/massInput.js
index 2e8b66863..2ddbda70c 100644
--- a/static/js/utils/massInput.js
+++ b/static/js/utils/massInput.js
@@ -5,14 +5,19 @@
    *
    * Mass Input Utility
    *  allows form shapes to be manipulated asynchronously:
-   *  will asynchronously submit the form and replace the contents of the
-   *  mass input with the one from the BE response
+   *  will asynchronously submit the containing form and replace the contents
+   *  of the mass input element with the one from the BE response
+   *  The utility will only trigger an AJAX request if the mass input element has
+   *  an active/focused element whilst the form is being submitted.
    *
    * Attribute:   uw-mass-input
-   *   (will be set up automatically on tables)
    *
    * Example usage:
-   *  (table with one column thats only checkboxes)
+   *  <form method="POST" action="...">
+   *   <input type="text">
+   *   <div uw-mass-input>
+   *     <input type="text">
+   *     <button type="submit">
    */
 
   var MASS_INPUT_UTIL_NAME = 'massInput';