From f6321a8e703b8b91f7043b6b55e0db06bbcd0a74 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Tue, 5 Dec 2017 16:33:18 -0600
Subject: Fix lint issues

---
 packages/subproviders/src/index.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'packages/subproviders/src/index.ts')

diff --git a/packages/subproviders/src/index.ts b/packages/subproviders/src/index.ts
index 9560c3597..9b7cab3fa 100644
--- a/packages/subproviders/src/index.ts
+++ b/packages/subproviders/src/index.ts
@@ -17,12 +17,20 @@ export {
     LedgerCommunicationClient,
 } from './types';
 
+/**
+ * A factory method for creating a LedgerEthereumClient usable in a browser context.
+ * @return LedgerEthereumClient A browser client
+ */
 export async function ledgerEthereumBrowserClientFactoryAsync(): Promise<LedgerEthereumClient> {
     const ledgerConnection = await LedgerBrowserCommunication.create_async();
     const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection);
     return ledgerEthClient;
 }
 
+/**
+ * A factory for creating a LedgerEthereumClient usable in a Node.js context.
+ * @return LedgerEthereumClient A Node.js client
+ */
 export async function ledgerEthereumNodeJsClientFactoryAsync(): Promise<LedgerEthereumClient> {
     const ledgerConnection = await LedgerNodeCommunication.create_async();
     const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection);
-- 
cgit v1.2.3