From 128cb1af46224da9c0f5158107b6ac2da40b0622 Mon Sep 17 00:00:00 2001
From: Dan <danjm.com@gmail.com>
Date: Tue, 17 Apr 2018 00:54:16 -0230
Subject: Improve documentation of promises that return undefined.
---
app/scripts/controllers/preferences.js | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
(limited to 'app/scripts/controllers/preferences.js')
diff --git a/app/scripts/controllers/preferences.js b/app/scripts/controllers/preferences.js
index cf0ca13a8..653e6d762 100644
--- a/app/scripts/controllers/preferences.js
+++ b/app/scripts/controllers/preferences.js
@@ -66,7 +66,7 @@ class PreferencesController {
* Setter for the `selectedAddress` property
*
* @param {string} _address A new hex address for an account
- * @returns {Promise<undefined>} Promises an undefined return value
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
setSelectedAddress (_address) {
@@ -159,7 +159,7 @@ class PreferencesController {
* Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list.
*
* @param {string} _url The the new rpc url to add to the updated list
- * @returns {Promise<undefined>} Promises an undefined value.
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
updateFrequentRpcList (_url) {
@@ -174,7 +174,7 @@ class PreferencesController {
* Setter for the `currentAccountTab` property
*
* @param {string} currentAccountTab Specifies the new tab to be marked as current
- * @returns {Promise<undefined>} Promises an undefined value.
+ * @returns {Promise<void>} Promise resolves with undefined
*
*/
setCurrentAccountTab (currentAccountTab) {
--
cgit