[PATCH v3 1/5] sprinter: clarify separator documentation

Jani Nikula jani at nikula.org
Sun Dec 16 13:02:37 PST 2012


For text printers, the separator is a syntactic element.
---
 sprinter.h |    9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/sprinter.h b/sprinter.h
index 59776a9..f43a844 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 *);
 
-- 
1.7.10.4



More information about the notmuch mailing list