From 7b5d506cec7fe182f64e71772c7f17bf697f31d8 Mon Sep 17 00:00:00 2001 From: Dan Date: Tue, 17 Apr 2018 00:55:10 -0230 Subject: Document async function as returning a promise. --- app/scripts/lib/get-first-preferred-lang-code.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/scripts/lib/get-first-preferred-lang-code.js b/app/scripts/lib/get-first-preferred-lang-code.js index 78448ad43..5473fccf0 100644 --- a/app/scripts/lib/get-first-preferred-lang-code.js +++ b/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 * 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} Promises a locale code, either one from the user's preferred list that we have a translation for, or 'en' * */ async function getFirstPreferredLangCode () { -- cgit