Update comments.
authorJohn Darrington <john@darrington.wattle.id.au>
Wed, 4 Jul 2018 19:33:28 +0000 (21:33 +0200)
committerJohn Darrington <john@darrington.wattle.id.au>
Wed, 4 Jul 2018 19:33:28 +0000 (21:33 +0200)
* src/data/spreadsheet-reader.h (struct spreadsheet_read_options): Elaborate
  comments.

src/data/spreadsheet-reader.h

index 37b249d4e9c4af6c4884ac7b7da8b2d4259e6b53..6b026b01cdae791365d6af3a3629e63f69f05244 100644 (file)
@@ -32,7 +32,8 @@ struct casereeader;
 struct spreadsheet_read_options
 {
   char *sheet_name ;       /* The name of the sheet to open (in UTF-8) */
-  int sheet_index ;        /* The index of the sheet to open (only used if sheet_name is NULL) */
+  int sheet_index ;        /* The index of the sheet to open (only used if sheet_name is NULL).
+                             The first index is 1 NOT 0 */
   char *cell_range ;       /* The cell range (in UTF-8) */
   bool read_names ;        /* True if the first row is to be used as the names of the variables */
   int asw ;                /* The width of string variables in the created dictionary */