fix(docs): ✏️ Adding comments

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>
ipfs · Aug 16, 2023 · 5e22cea · 5e22cea
1 parent 832679d
commit 5e22cea
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/add-on/src/lib/redirect-handler/blockOrObserve.ts b/add-on/src/lib/redirect-handler/blockOrObserve.ts
@@ -124,12 +124,14 @@ function escapeURLRegex (str: string): string {
 }
 
 /**
- * Compute the namespace from the URL.
+ * Compute the namespace from the URL. This finds the first path segment.
+ * e.g. http://<gateway>/<namespace>/path/to/file/or/cid
  *
  * @param url string
  */
 function computeNamespaceFromUrl (url: string): string {
   const { pathname } = new URL(url)
+  // regex to match the first path segment.
   return (/\/([^/]+)\//i.exec(pathname)?.[1] ?? '').toLowerCase()
 }