refactor & add comment

facebook · May 31, 2018 · b8b8f5b · b8b8f5b
1 parent 8620324
commit b8b8f5b
Showing 1 changed file with 4 additions and 6 deletions.
diff --git a/lib/server/readMetadata.js b/lib/server/readMetadata.js
@@ -162,13 +162,11 @@ function processMetadata(file) {
     throw new Error('Document id cannot include "/".');
   }
 
-  // if file is located in subdirectory,
-  // it will have the directory name appended to it's id
-  const relativeFile = path.relative(
-    path.join(CWD, '../', getDocsPath()),
-    file
+  // If a doc file is located in a subdirectory, prepend the subdir to it's ID
+  // Example: `docs/projectA/test.md` with 'test' ID is changed to `projectA/test`
+  const curDir = path.dirname(
+    path.relative(path.join(CWD, '../', getDocsPath()), file)
   );
-  const curDir = path.dirname(relativeFile);
   if (curDir !== '.') {
     metadata.id = curDir + '/' + metadata.id;
     metadata.source = curDir + '/' + metadata.source;