Skip to content

Commit

Permalink
Tidy up some comments
Browse files Browse the repository at this point in the history
  • Loading branch information
rachaelshaw committed Sep 15, 2019
1 parent b47d465 commit d2bd6db
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions lib/app/configuration/default-hooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Default hooks
*
* (order still matters for now for some of these-
* but mostly not, due to ouruse of events...
* but mostly not, due to our use of events...
* ...but for a few core hooks, e.g. `moduleloader`,
* it still does.)
*
Expand All @@ -17,14 +17,14 @@ module.exports = {
'logger': true,//<< FUTURE: absorb into core (i.e. like what we did w/ the controllers hook -- can live in `lib/app/private/log-ship.js`, and the rest can be inlined)
'request': true,

// -•- For poterity, this is where the `orm` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)
// -•- For posterity, this is where the `orm` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)

'views': true,
'blueprints': true,//<< FUTURE: pull this out into a standalone hook and have it work like the other core hooks that get installed as peers (unless you do --without=blueprints)
'responses': true,
'helpers': true,

// -•- For poterity, this is where the `sockets` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)
// -•- For posterity, this is where the `sockets` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)

'pubsub': true,//<< FUTURE: **pull the private methods into the blueprints hook, and pull the PUBLIC methods into sails-hook-sockets -- i.e. if orm hook available, then sails-hook-sockets decorates models with RPS methods**
'policies': true,
Expand All @@ -34,7 +34,7 @@ module.exports = {
'userconfig': true,//<< FUTURE: absorb into core (i.e. like what we did w/ the controllers hook -- can live in `lib/app/configuration`)
'session': true,

// -•- For poterity, this is where the `grunt` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)
// -•- For posterity, this is where the `grunt` hook was formerly inserted (please don't get rid of this until we're a few patch releases into Sails v1, just so it's easier to reference.)

'http': true,
'userhooks': true//<< FUTURE: absorb into core (i.e. like what we did w/ the controllers hook -- its logic can live in `lib/app/private`, and be driven by `lib/hooks/index.js`)
Expand Down
4 changes: 2 additions & 2 deletions lib/app/configuration/load.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ module.exports = function(sails) {
async.auto({

/**
* Until this point this point, `sails.config` is composed only of
* Until this point, `sails.config` is composed only of
* configuration overrides passed into `sails.lift(overrides)`
* (or `sails.load(overrides)`-- same thing)
*
* This step clones this into an "overrides" object, negotiating cmdline
* shortcuts into the properly namespced sails configuration options.
* shortcuts into the properly namespaced sails configuration options.
*/
mapOverrides: function(cb) {

Expand Down
6 changes: 3 additions & 3 deletions lib/app/configuration/rc.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ var rttc = require('rttc');

/**
* Load configuration from .rc files and env vars
* @param {string} namespace Namespace to look for env vars under (defaults to `sails`)
* @return {dictionary} A dictionary of config values gathered from .rc files, with env vars and command line options merged on top
* @param {String} namespace [namespace to look for env vars under (defaults to `sails`)]
* @return {Dictionary} A dictionary of config values gathered from .rc files, with env vars and command line options merged on top
*/

module.exports = function(namespace) {
Expand All @@ -26,7 +26,7 @@ module.exports = function(namespace) {
// guesstimate the types.
// NOTE -- the code below is lifted from the `rc` module, and modified to:
// 1. Pass JSHint
// 2. Run parseHuman on values
// 2. Run `parseHuman` on values
// If at some point `rc` exposes metadata about which configs came from
// the environment, we can simplify our code by just running `parseHuman`
// on those values instead of doing the work to pluck them from the env.
Expand Down
4 changes: 2 additions & 2 deletions lib/app/private/after.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ module.exports = function mixinAfter(emitter) {
* Override `EventEmitter.prototype.emit` to keep track of all the events that have occurred once.
* (Required to support `emitter.after()`)
*
* @param {String} eventName name of the event
* @return {boolean} Returns true if the event had listeners, false otherwise.
* @param {String} eventName [name of the event]
* @return {Boolean} Returns true if the event had listeners, false otherwise.
* @see https://nodejs.org/api/events.html#events_emitter_emit_eventname_args
*/
emitter.emit = function(eventName) {
Expand Down

0 comments on commit d2bd6db

Please sign in to comment.