From 1e65e7c996d6d21ebe6b1ebdcdc3f5340913ec24 Mon Sep 17 00:00:00 2001
From: Jan Kanis <jan.code@jankanis.nl>
Date: Wed, 23 Jan 2013 01:29:24 +0100
Subject: [PATCH] extra comments

---
 reader.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/reader.h b/reader.h
index f26f27405..f7cc7fdca 100644
--- a/reader.h
+++ b/reader.h
@@ -135,8 +135,10 @@ int reader_reading_interrupted();
 /**
    Returns true if the current reader generation count does not equal the 
    generation count the current thread was started with. 
-   Note: currently only valid for autocompletion threads! Other threads don't
+   Note 1: currently only valid for autocompletion threads! Other threads don't
    set the threadlocal generation count when they start up. 
+   Note 2: This function uses conditional compilation for thread-local storage. 
+   If the compiler doesn't support that this function always returns `false`.
 */
 bool reader_cancel_thread();