Skip to content

Commit 1ba4bcb

Browse files
committed
Update the OPTIONS.md readme file.
1 parent aeb9a24 commit 1ba4bcb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README/OPTIONS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ struct _tidy_option
3838
TidyOptionType type; /* string, int or bool */
3939
ulong dflt; /* default for TidyInteger and TidyBoolean */
4040
ParseProperty* parser; /* parsing method, read-only if NULL */
41-
const ctmbstr* pickList; /* pick list */
41+
PickListItems* pickList; /* pick list */
4242
ctmbstr pdflt; /* default for TidyString */
4343
};
4444
~~~
@@ -78,7 +78,7 @@ Care, each of these enumeration strings have been equated to two uppercase lette
7878

7979
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.
8080

81-
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.
81+
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.
8282

8383
Presently no options have the final `default` string, and it is left out of the table. The compiler will add a NULL.
8484

0 commit comments

Comments
 (0)