From 1c99b36be019c42bf2bfb01d89cb6cc150723912 Mon Sep 17 00:00:00 2001
From: Felix Hamann <felix.hamann@campus.lmu.de>
Date: Wed, 10 Apr 2019 20:03:05 +0200
Subject: [PATCH] add documentation for async form internationalization

---
 static/js/utils/asyncForm.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/static/js/utils/asyncForm.js b/static/js/utils/asyncForm.js
index 4b7b94951..eaf6f9221 100644
--- a/static/js/utils/asyncForm.js
+++ b/static/js/utils/asyncForm.js
@@ -12,6 +12,11 @@
    * Example usage:
    *   <form uw-async-form method='POST' action='...'>
    *     ...
+   *
+   * Internationalization:
+   *  This utility expects the following translations to be available:
+   *    asyncFormFailure: text that gets shown if an async form request fails
+   *      example: "Oops. Something went wrong."
    */
 
   var ASYNC_FORM_UTIL_NAME = 'asyncForm';