From 92d56ca29ed5db49a208280c45155850a9c7a76b Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Thu, 31 Dec 2020 21:04:12 -0800 Subject: [PATCH] pivot-table: Update comments to drop mention of omit_empty. Commit 0200682d517f ("pivot-table: Change the default format to omit empty rows and columns.") eliminated the need for this. --- src/output/pivot-table.c | 27 +++++++-------------------- src/output/pivot-table.h | 14 +++++--------- 2 files changed, 12 insertions(+), 29 deletions(-) diff --git a/src/output/pivot-table.c b/src/output/pivot-table.c index 4c1b2c7522..aa5b181c52 100644 --- a/src/output/pivot-table.c +++ b/src/output/pivot-table.c @@ -796,18 +796,10 @@ pivot_result_class_change (const char *s_, const struct fmt_spec *format) e.g. N_("Descriptive Statistics"). The un-translated text string is used as the pivot table's subtype. - Operations commonly performed on the new pivot_table: - - - If empty rows or columns should not be displayed, set ->omit_empty to - true. - - - Set the format to use for "count" values with pivot_table_set_weight_var() - or pivot_table_set_weight_format(). - This function is a shortcut for pivot_table_create__() for the most common case. Use pivot_table_create__() directly if the title should be some kind of value other than an ordinary text string, or if the subtype should be -different from the title. + different from the title. See the large comment at the top of pivot-table.h for general advice on creating pivot tables. */ @@ -818,18 +810,13 @@ pivot_table_create (const char *title) } /* Creates and returns a new pivot table with the given TITLE, and takes - ownership of TITLE. The new pivot table's subtype is SUBTYPE, which - should be an untranslated English string that describes the contents of - the table at a high level without being specific about the variables or - other context involved. - - Operations commonly performed on the new pivot_table: - - - If empty rows or columns should not be displayed, set ->omit_empty to - true. + ownership of TITLE. The new pivot table's subtype is SUBTYPE, which should + be an untranslated English string that describes the contents of the table + at a high level without being specific about the variables or other context + involved. - - Set the format to use for "count" values with pivot_table_set_weight_var() - or pivot_table_set_weight_format(). + TITLE and SUBTYPE may be NULL, but in that case the client must add them + later because they are both mandatory for a pivot table. See the large comment at the top of pivot-table.h for general advice on creating pivot tables. */ diff --git a/src/output/pivot-table.h b/src/output/pivot-table.h index be82d0685e..de50c7f39e 100644 --- a/src/output/pivot-table.h +++ b/src/output/pivot-table.h @@ -60,15 +60,11 @@ union value; Creating a pivot table usually consists of the following steps: 1. Create the table with pivot_table_create(), passing in the title. - It's commonly useful to set up a few options at this point: - - If empty rows or columns should not be displayed, set ->omit_empty to - true. + 2. Optionally, set the format to use for "count" values with + pivot_table_set_weight_var() or pivot_table_set_weight_format(). - - Set the format to use for "count" values with - pivot_table_set_weight_var() or pivot_table_set_weight_format(). - - 2. Create each dimension with pivot_dimension_create() and populate it with + 3. Create each dimension with pivot_dimension_create() and populate it with categories and, possibly, with groups that contain the categories. This call also assigns the dimension to an axis. @@ -81,14 +77,14 @@ union value; first cell for that variable. In that case, creating categories and inserting data can be interleaved. - 3. Insert data. For each cell, supply the category indexes, which are + 4. Insert data. For each cell, supply the category indexes, which are assigned starting from 0 in the order in which the categories were created in step 2, and the value to go in the cell. If the table has a small, fixed number of dimensions, functions like, e.g. pivot_table_put3() for 3 dimensions, can be used. The general function pivot_table_put() works for other cases. - 4. Output the table for user consumption. Use pivot_table_submit(). */ + 5. Output the table for user consumption. Use pivot_table_submit(). */ /* Pivot table display styling. */ -- 2.30.2