From 2ebc64b271fcc28ac8da62044cca372e186d2ba3 Mon Sep 17 00:00:00 2001
From: Gregory Schier <gschier1990@gmail.com>
Date: Wed, 9 Nov 2016 18:45:43 -0800
Subject: [PATCH] Fixed up querystring comments

---
 app/backend/querystring.js | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/app/backend/querystring.js b/app/backend/querystring.js
index cd843d656c..2c5931c1a7 100644
--- a/app/backend/querystring.js
+++ b/app/backend/querystring.js
@@ -1,18 +1,22 @@
 import * as util from '../common/misc.js';
 
+/** Join a URL with a querystring  */
+export function joinURL (url, qs) {
+  if (!qs) {
+    return url;
+  }
+
+  // TODO: Make this work with URLs that have a #hash component
+  url = url || '';
+  return url + getJoiner(url) + qs;
+}
+
 export function getJoiner (url) {
   url = url || '';
   return url.indexOf('?') === -1 ? '?' : '&';
 }
 
-export function joinURL (url, qs) {
-  if (!qs) {
-    return url;
-  }
-  url = url || '';
-  return url + getJoiner(url) + qs;
-}
-
+/** Build a querystring param out of a name/value pair */
 export function build (param, strict = true) {
   // Skip non-name ones in strict mode
   if (strict && !param.name) {
@@ -29,10 +33,9 @@ export function build (param, strict = true) {
 }
 
 /**
- *
+ * Build a querystring from a list of name/value pairs
  * @param parameters
  * @param strict allow empty names and values
- * @returns {string}
  */
 export function buildFromParams (parameters, strict = true) {
   let items = [];
@@ -50,10 +53,9 @@ export function buildFromParams (parameters, strict = true) {
 }
 
 /**
- *
+ * Deconstruct a querystring to name/value pairs
  * @param qs
  * @param strict allow empty names and values
- * @returns {Array}
  */
 export function deconstructToParams (qs, strict = true) {
   const stringPairs = qs.split('&');