add docs for argparse.boolean

added entry to changelog as well.
2023-09-09 14:30:20 -06:00 · 2023-09-09 14:30:20 -06:00 · 652349c7e7
parent 85cd0cd01c
commit 652349c7e7
2 changed files with 7 additions and 0 deletions
--- a/docs/changelog.txt
+++ b/docs/changelog.txt
@ -64,6 +64,7 @@ Template for new versions:
 ## API

 ## Lua
+- ``argparse.boolean``: convert arguments to lua boolean values.

 ## Removed

--- a/docs/dev/Lua
+++ b/docs/dev/Lua
@ -3538,6 +3538,12 @@ parameters.
  ``tonumber(arg)``. If ``arg_name`` is specified, it is used to make error
  messages more useful.

+* ``argparse.boolean(arg, arg_name)``
+  Converts ``string.lower(arg)`` from "yes/no/on/off/true/false/etc..." to a lua
+  boolean. Throws if the value can't be converted, otherwise returns
+  ``true``/``false``. If ``arg_name`` is specified, it is used to make error
+  messages more useful.
+
 dumper
 ======