Document async function as returning a promise.

feature/default_network_editable
Dan 7 years ago
parent 128cb1af46
commit 7b5d506cec
  1. 2
      app/scripts/lib/get-first-preferred-lang-code.js

@ -8,7 +8,7 @@ const existingLocaleCodes = allLocales.map(locale => locale.code.toLowerCase().r
* Returns a preferred language code, based on settings within the user's browser. If we have no translations for the * Returns a preferred language code, based on settings within the user's browser. If we have no translations for the
* users preferred locales, 'en' is returned. * users preferred locales, 'en' is returned.
* *
* @returns {string} A locale code, either one from the user's preferred list that we have a translation for, or 'en' * @returns {Promise<string>} Promises a locale code, either one from the user's preferred list that we have a translation for, or 'en'
* *
*/ */
async function getFirstPreferredLangCode () { async function getFirstPreferredLangCode () {

Loading…
Cancel
Save