From: Jani Nikula <jani@nikula.org>
Date: Sun, 16 Dec 2012 22:05:09 +0000 (+0200)
Subject: sprinter: clarify separator documentation
X-Git-Tag: 0.15_rc1~67
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=1358f93a9f9c827f43ad174dc7bbf27b90d2ef8a;hp=480f44fbe47a068626dbb7c7d9e9b1fb72a5da0f

sprinter: clarify separator documentation

For text printers, the separator is a syntactic element.
---

diff --git a/sprinter.h b/sprinter.h
index 59776a9c..f43a8443 100644
--- a/sprinter.h
+++ b/sprinter.h
@@ -42,10 +42,11 @@ typedef struct sprinter {
      */
     void (*map_key) (struct sprinter *, const char *);
 
-    /* Insert a separator (usually extra whitespace) for improved
-     * readability without affecting the abstract syntax of the
-     * structure being printed.
-     * For JSON, this could simply be a line break.
+    /* Insert a separator (usually extra whitespace). For the text
+     * printers, this is a syntactic separator. For the structured
+     * printers, this is for improved readability without affecting
+     * the abstract syntax of the structure being printed. For JSON,
+     * this could simply be a line break.
      */
     void (*separator) (struct sprinter *);