From 85f18850a96071fcac84f1b1c7338d7e61c54be2 Mon Sep 17 00:00:00 2001 From: Naz Date: Mon, 27 Sep 2021 13:55:39 +0200 Subject: [PATCH] Cleaned up loader method docs refs https://linear.app/tryghost/issue/CORE-35/refactor-route-and-redirect-settings - There were duplicate descriptions of the same thing in multiple places. Made the description a bit more accurate given the latest changes --- core/server/services/route-settings/loader.js | 6 +++--- core/server/services/route-settings/route-settings.js | 6 ------ 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/core/server/services/route-settings/loader.js b/core/server/services/route-settings/loader.js index 439ae30d97..f031046cf4 100644 --- a/core/server/services/route-settings/loader.js +++ b/core/server/services/route-settings/loader.js @@ -57,10 +57,10 @@ const loadSettings = async () => { }; /** - * Reads the desired settings YAML file and passes the + * Reads the routes.yaml settings file and passes the * file to the YAML parser which then returns a JSON object. - * NOTE: loading happens synchronously - * @returns {Object} settingsFile + * + * @returns {Object} settingsFile in following format: {routes: {}, collections: {}, resources: {}} */ module.exports.loadSettingsSync = function loadSettingsSync() { const setting = 'routes'; diff --git a/core/server/services/route-settings/route-settings.js b/core/server/services/route-settings/route-settings.js index 39b4e1445c..b14812193b 100644 --- a/core/server/services/route-settings/route-settings.js +++ b/core/server/services/route-settings/route-settings.js @@ -145,12 +145,6 @@ const init = function () { }; module.exports.init = init; -/** - * Fetches routes YAML settings synchronously. - * will return a JSON Object like this: - * {routes: {}, collections: {}, resources: {}} - * @returns {Object} routes.yaml in JSON format - */ module.exports.loadRouteSettingsSync = SettingsLoader.loadSettingsSync; module.exports.api = {