From 58ddc29538ff9d8eaea1be6fcaba34d05a8d45a2 Mon Sep 17 00:00:00 2001
From: Alexandre Bodin <bodin.alex@gmail.com>
Date: Mon, 24 Jun 2019 15:37:02 +0200
Subject: [PATCH] add comments

---
 .../controllers/Groups.js                     |  1 +
 .../services/Groups.js                        | 21 +++++++++++++++++--
 2 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/packages/strapi-plugin-content-type-builder/controllers/Groups.js b/packages/strapi-plugin-content-type-builder/controllers/Groups.js
index e74df67ba8..7adb224be2 100644
--- a/packages/strapi-plugin-content-type-builder/controllers/Groups.js
+++ b/packages/strapi-plugin-content-type-builder/controllers/Groups.js
@@ -10,6 +10,7 @@ const groupSchema = yup.object().shape({
   attributes: yup.object().required(),
 });
 
+// shorter access to the group service
 const internals = {
   get service() {
     return strapi.plugins['content-type-builder'].services.groups;
diff --git a/packages/strapi-plugin-content-type-builder/services/Groups.js b/packages/strapi-plugin-content-type-builder/services/Groups.js
index 6e022225bd..5766608888 100644
--- a/packages/strapi-plugin-content-type-builder/services/Groups.js
+++ b/packages/strapi-plugin-content-type-builder/services/Groups.js
@@ -5,6 +5,10 @@ const slugify = require('@sindresorhus/slugify');
 
 const VALID_FIELDS = ['name', 'connection', 'collectionName', 'attributes'];
 
+/**
+ * Create a schema
+ * @param {Object} infos
+ */
 const createSchema = infos => {
   const { name, connection = 'default', collectionName } = infos;
   const uid = createGroupUID(name);
@@ -17,9 +21,18 @@ const createSchema = infos => {
   };
 };
 
-const updateSchema = (oldSchema, newSchema) =>
-  pick({ ...oldSchema, ...newSchema }, VALID_FIELDS);
+/**
+ * Update a group schema
+ * @param {Object} currentSchema - current group schema
+ * @param {Object} newSchema - new group schema
+ */
+const updateSchema = (currentSchema, newSchema) =>
+  pick({ ...currentSchema, ...newSchema }, VALID_FIELDS);
 
+/**
+ * Returns a uid from a string
+ * @param {string} str - string to slugify
+ */
 const createGroupUID = str => slugify(str, { separator: '_' });
 
 /**
@@ -52,6 +65,10 @@ async function updateGroup(group, infos) {
   return writeSchema(uid, updatedSchema);
 }
 
+/**
+ * Deletes a group
+ * @param {*} group
+ */
 async function deleteGroup(group) {
   await deleteSchema(group.uid);
   process.nextTick(() => strapi.reload());