server: remove some unnecessary code comments

iterative · Jan 5, 2020 · 6e0f9f6 · 6e0f9f6
1 parent 1a8bbda
commit 6e0f9f6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 17 deletions.
diff --git a/server.js b/server.js
@@ -25,7 +25,7 @@ app.prepare().then(() => {
     const { pathname, query } = parsedUrl
 
     /*
-     * Special URL redirects.
+     * HTTP redirects
      * NOTE: The order of the redirects is important.
      */
     if (
@@ -111,14 +111,12 @@ app.prepare().then(() => {
       res.end()
     } else if (/^\/doc(\/.*)?$/.test(pathname)) {
       /*
-       * Special Docs Engine handler
-       * Based on /pages/doc.js page.
+       * Docs Engine handler
        */
 
-      // Force 404 response for any inexistent /doc item.
+      // Force 404 response code for any inexistent /doc item.
       if (!getItemByPath(pathname)) {
         res.statusCode = 404
-        // NOTE: Assumes the route below will render a 404 page.
       }
 
       // Custom route for all docs
@@ -128,7 +126,6 @@ app.prepare().then(() => {
       handle(req, res, parsedUrl)
     }
   }).listen(port, err => {
-    // Invokes `createServer` server.
     if (err) throw err
     console.info(`> Ready on localhost:${port}`)
   })

diff --git a/src/utils/sidebar.js b/src/utils/sidebar.js
@@ -19,8 +19,6 @@
 */
 
 const startCase = require('lodash.startcase')
-
-// Base to build the target struct described above
 const sidebar = require('../../public/static/docs/sidebar.json')
 
 const PATH_ROOT = '/doc/'
@@ -58,7 +56,6 @@ function findItem(data, targetPath) {
   }
 }
 
-// Recursive
 function findPrevItemWithSource(data, item) {
   if (item && item.source) {
     return item
@@ -93,7 +90,6 @@ function normalizeItem({ rawItem, parentPath, resultRef, prevRef }) {
   }
 }
 
-// Recursive
 function normalizeSidebar({
   data,
   parentPath,
@@ -137,7 +133,6 @@ function normalizeSidebar({
   return currentResult
 }
 
-// Recursive
 function findChildWithSource(item) {
   return item.source ? item : findChildWithSource(item.children[0])
 }
@@ -146,17 +141,11 @@ function findChildWithSource(item) {
  * Exports
  */
 
-// Runs at module load time
 const normalizedSidebar = normalizeSidebar({
   data: sidebar,
   parentPath: ''
 })
 
-/**
- * Finds `path` in sidebar struct
- * @param {*} path
- * @uses `normalizedSidebar`
- */
 function getItemByPath(path) {
   const normalizedPath = path.replace(/\/$/, '')
   const isRoot = normalizedPath === PATH_ROOT.slice(0, -1)