math: Improve comments.

[pspp] / src / math / sort.c

diff --git a/src/math/sort.c b/src/math/sort.c
index a784960420874dd17d0bff8ba8715d824506614b..a93466f27c8386cfa1692d2ff349d316197e3c65 100644 (file)
--- a/src/math/sort.c
+++ b/src/math/sort.c
@@ -60,6 +60,9 @@ static struct ccase *pqueue_pop (struct pqueue *, casenumber *);
 
 static void output_record (struct sort_writer *);
 
+/* Creates a casewriter that sorts the cases written to it.  Once all the cases
+   have been written, use casewriter_make_reader() to obtain the sorted
+   results. */
 struct casewriter *
 sort_create_writer (const struct subcase *ordering,
                     const struct caseproto *proto)