Add comments informing the caller about side effects

[pspp-builds.git] / src / data / casereader.c

diff --git a/src/data/casereader.c b/src/data/casereader.c
index 98c10273b314dd4bbc4f81170e485136a828a756..9f3d5cf9dbeb25c94683a8f739218d6cb6c0ba0d 100644 (file)
--- a/src/data/casereader.c
+++ b/src/data/casereader.c
@@ -331,7 +331,7 @@ casereader_advance (struct casereader *reader, casenumber n)
 
 
 /* Copies all the cases in READER to WRITER, propagating errors
-   appropriately. */
+   appropriately. READER is destroyed by this function */
 void
 casereader_transfer (struct casereader *reader, struct casewriter *writer)
 {