From 37230ce7fa5b1e54ac1968252c8b505b8b733e71 Mon Sep 17 00:00:00 2001
From: Chi Vinh Le <vinh@wikiwi.io>
Date: Mon, 3 Apr 2017 14:48:16 +0700
Subject: [PATCH] Add more docs to plugins loader

---
 client/coral-framework/loaders/plugins-loader.js | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/client/coral-framework/loaders/plugins-loader.js b/client/coral-framework/loaders/plugins-loader.js
index e264fb628..f1705933f 100644
--- a/client/coral-framework/loaders/plugins-loader.js
+++ b/client/coral-framework/loaders/plugins-loader.js
@@ -1,3 +1,14 @@
+/**
+ * Executes `source` to retrieve plugins configuration
+ * and loads all modules of specified plugins.
+ *
+ * Outputs a module that looks like the following:
+ *
+ * module.exports.actions = [{plugin: string, module: callback}, ...]
+ * module.exports.reducer = [{plugin: string, module: callback}, ...]
+ * [...]
+ *
+ */
 const {stripIndent} = require('common-tags');
 const fs = require('fs');
 const path = require('path');