0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-10 23:36:14 -05:00

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
This commit is contained in:
Naz 2021-09-27 13:55:39 +02:00 committed by naz
parent ebc33180a1
commit 85f18850a9
2 changed files with 3 additions and 9 deletions

View file

@ -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';

View file

@ -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 = {