From a4aeefa53c1cb48fe9c59070c4d8231a90c126ff Mon Sep 17 00:00:00 2001
From: Jorik Schellekens <joriksch@gmail.com>
Date: Thu, 11 Jun 2020 02:10:56 +0100
Subject: [PATCH] Doc lints

---
 src/parser/parser.ts | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/parser/parser.ts b/src/parser/parser.ts
index d00fb58..f863f59 100644
--- a/src/parser/parser.ts
+++ b/src/parser/parser.ts
@@ -10,7 +10,8 @@ import {
 
 /*
  * Verifiers are regexes which will match valid
- * identifiers to their type
+ * identifiers to their type. (This is a lie, they
+ * can return anything)
  */
 type Verifier<A> = [RegExp, A];
 export const roomVerifiers: Verifier<
@@ -91,7 +92,7 @@ export function parsePermalink(identifier: string) {
 
 /*
  * descriminate applies the verifiers to the identifier and
- * returns it's type
+ * returns the identifier's type
  */
 export function discriminate<T, F>(
   identifier: string,
@@ -143,9 +144,9 @@ export function parseArgs(args: string): Arguments {
 }
 
 /*
- * toURI converts a parsed link to uri. Typically it's recommended
- * to show the original link if it existed but this is handy in the
- * case where this was constructed.
+ * toURI converts a Link to uri. It's recommended
+ * to use the original link instead of toURI if it existed.
+ * This is handy function in case the Link was constructed.
  */
 export function toURI(hostname: string, link: SafeLink): string {
   const cleanHostname = hostname.trim().replace(/\/+$/, "");