From: Tim Vaughan <tgvaughan@gmail.com>
Date: Thu, 2 May 2019 14:48:35 +0000 (+0200)
Subject: A few explanatory comments.
X-Git-Tag: v1.0.0~7
X-Git-Url: https://thelambdalab.xyz/gitweb/index.cgi?a=commitdiff_plain;h=3ff645a8f4052ceabec5b24582bf004f6dabbfcf;p=elpher.git

A few explanatory comments.
---

diff --git a/elpher.el b/elpher.el
index 7add720..ca3a82a 100644
--- a/elpher.el
+++ b/elpher.el
@@ -292,6 +292,8 @@ content and cursor position fields of the node."
 
 (defun elpher-insert-index (string)
   "Insert the index corresponding to STRING into the current buffer."
+  ;; Should be able to split directly on CRLF, but some non-conformant
+  ;; LF-only servers sadly exist, hence the following.
   (dolist (line (split-string (replace-regexp-in-string "\r" "" string) "\n"))
     (unless (= (length line) 0)
       (elpher-insert-index-record line))))
@@ -333,10 +335,10 @@ content and cursor position fields of the node."
                               'help-echo (format "mouse-1, RET: open %s on %s port %s"
                                                  selector host port)))
       (pcase type
-        (?i (elpher-insert-margin) ; Information
+        (?i (elpher-insert-margin) ;; Information
             (insert (propertize display-string
                                 'face 'elpher-info)))
-        (?h (elpher-insert-margin "W") ; Web link
+        (?h (elpher-insert-margin "W") ;; Web link
             (let ((url (elt (split-string selector "URL:") 1)))
               (insert-text-button display-string
                                   'face 'elpher-url
@@ -344,7 +346,7 @@ content and cursor position fields of the node."
                                   'action #'elpher-click-url
                                   'follow-link t
                                   'help-echo (format "mouse-1, RET: open url %s" url))))
-        (?.) ; Occurs at end of index, can safely ignore.
+        (?.) ;; Occurs at end of index, can safely ignore.
         (tp (elpher-insert-margin (concat (char-to-string tp) "?"))
             (insert (propertize display-string
                                 'face 'elpher-unknown-face)))))