From 5fe6845d7cdc7681f0dab20bf7e162683132cd76 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Garc=C3=ADa=20Aubert?=
 <danielgarciaaubert@gmail.com>
Date: Tue, 1 Oct 2019 19:48:16 +0200
Subject: [PATCH] Add comments

---
 config/environments/development.js.example | 5 ++++-
 config/environments/production.js.example  | 5 ++++-
 config/environments/staging.js.example     | 5 ++++-
 config/environments/test.js.example        | 5 ++++-
 4 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/config/environments/development.js.example b/config/environments/development.js.example
index 54761d97..a9cb7a78 100644
--- a/config/environments/development.js.example
+++ b/config/environments/development.js.example
@@ -16,13 +16,16 @@ var config = {
     // Base URLs for the APIs
     //
     // See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
+    //
+    // Note: each entry corresponds with an express' router.
+    // You must define at least one path. However, middlewares are optional.
     ,routes: {
         api: {
             paths: [
                 '/api/v1',
                 '/user/:user/api/v1',
             ],
-            // Optional: attach middlewares at the begining of the req/res cycle
+            // Optional: attach middlewares at the begining of the router
             // to perform custom operations.
             middlewares: [
                 function noop () {
diff --git a/config/environments/production.js.example b/config/environments/production.js.example
index 623623c2..f6babe62 100644
--- a/config/environments/production.js.example
+++ b/config/environments/production.js.example
@@ -16,13 +16,16 @@ var config = {
     // Base URLs for the APIs
     //
     // See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
+    //
+    // Note: each entry corresponds with an express' router.
+    // You must define at least one path. However, middlewares are optional.
     ,routes: {
         api: {
             paths: [
                 '/api/v1',
                 '/user/:user/api/v1',
             ],
-            // Optional: attach middlewares at the begining of the req/res cycle
+            // Optional: attach middlewares at the begining of the router
             // to perform custom operations.
             middlewares: [
                 function noop () {
diff --git a/config/environments/staging.js.example b/config/environments/staging.js.example
index f3baa4fa..a2675eb3 100644
--- a/config/environments/staging.js.example
+++ b/config/environments/staging.js.example
@@ -16,13 +16,16 @@ var config = {
     // Base URLs for the APIs
     //
     // See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
+    //
+    // Note: each entry corresponds with an express' router.
+    // You must define at least one path. However, middlewares are optional.
     ,routes: {
         api: {
             paths: [
                 '/api/v1',
                 '/user/:user/api/v1',
             ],
-            // Optional: attach middlewares at the begining of the req/res cycle
+            // Optional: attach middlewares at the begining of the router
             // to perform custom operations.
             middlewares: [
                 function noop () {
diff --git a/config/environments/test.js.example b/config/environments/test.js.example
index f41e4ca9..9f69f2f0 100644
--- a/config/environments/test.js.example
+++ b/config/environments/test.js.example
@@ -16,13 +16,16 @@ var config = {
     // Base URLs for the APIs
     //
     // See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
+    //
+    // Note: each entry corresponds with an express' router.
+    // You must define at least one path. However, middlewares are optional.
     ,routes: {
         api: {
             paths: [
                 '/api/v1',
                 '/user/:user/api/v1',
             ],
-            // Optional: attach middlewares at the begining of the req/res cycle
+            // Optional: attach middlewares at the begining of the router
             // to perform custom operations.
             middlewares: [
                 function noop () {