From 3fe40026c9cdbf07d169186d5f5e6d4924f52cfc Mon Sep 17 00:00:00 2001 From: jon-edward Date: Sun, 1 Jun 2025 14:38:58 -0400 Subject: [PATCH] Add lists of values to module documentation --- argparse_dataclass.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/argparse_dataclass.py b/argparse_dataclass.py index 4a5baf3..c530f09 100644 --- a/argparse_dataclass.py +++ b/argparse_dataclass.py @@ -118,6 +118,20 @@ >>> print(parser.parse_args(["--name", "john doe"])) Options(name='John Doe') +Parsing a list of values: + +.. code-block:: pycon + + >>> from dataclasses import dataclass, field + >>> from argparse_dataclass import ArgumentParser + >>> @dataclass + ... class Options: + ... names: list[str] = field(metadata=dict(type=str, nargs="+")) + ... + >>> parser = ArgumentParser(Options) + >>> print(parser.parse_args(["--names", "john", "jane"])) + Options(names=['john', 'jane']) + Configuring a flag to have a default value of True: .. code-block:: pycon