From 1ba4bcb7532f54ec8516e1e94ddff7976f1c7283 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Thu, 11 May 2017 14:54:53 -0400 Subject: [PATCH] Update the OPTIONS.md readme file. --- README/OPTIONS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README/OPTIONS.md b/README/OPTIONS.md index 5622f3f..ff0d84e 100644 --- a/README/OPTIONS.md +++ b/README/OPTIONS.md @@ -38,7 +38,7 @@ struct _tidy_option TidyOptionType type; /* string, int or bool */ ulong dflt; /* default for TidyInteger and TidyBoolean */ ParseProperty* parser; /* parsing method, read-only if NULL */ - const ctmbstr* pickList; /* pick list */ + PickListItems* pickList; /* pick list */ ctmbstr pdflt; /* default for TidyString */ }; ~~~ @@ -78,7 +78,7 @@ Care, each of these enumeration strings have been equated to two uppercase lette The next item is the `default` value for a boolean, tristate or integer. Note tidy set `no=0` and `yes=1` as its own `Bool` enumeration. -There are a number of `parser` for the options. Likewise a number of `pickList`. Find another option similar to your new option and use the same values. +There are a number of `parser` for the options. Likewise a number of `pickList`. Find another option similar to your new option and use the same values. The `parser` is the function that parses config file or command line text input, and the `picklist` constitutes the canonical values for the option. Some types of values logically don't have picklists, such as strings or pure integers. Presently no options have the final `default` string, and it is left out of the table. The compiler will add a NULL.