1 files changed, 7 insertions, 0 deletions
diff --git a/app/assets/javascripts/dirty_submit/dirty_submit_form.js b/app/assets/javascripts/dirty_submit/dirty_submit_form.js
index 765969daa32..ecc8e0fe562 100644
--- a/app/assets/javascripts/dirty_submit/dirty_submit_form.js
+++ b/app/assets/javascripts/dirty_submit/dirty_submit_form.js
@@ -1,6 +1,13 @@
 import _ from 'underscore';
 import $ from 'jquery';
 
+/**
+ * Prevent submitting forms with no changes.
+ * Currently handles `input`, `textarea` and `select` elements.
+ *
+ * @param {form} a NodeList (e.g. document.querySelector('form'))
+ */
+
 class DirtySubmitForm {
   constructor(form) {
     this.form = form;