Skip to content

Add documentation for DEFINE_enum_class #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
axgillies merged 3 commits into from
Jun 16, 2025
Merged

Add documentation for DEFINE_enum_class #328

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a36ad4
Add documentation for `DEFINE_enum_class`
brianquinlan Mar 17, 2020
7e7e86e
Fix line lengths.
brianquinlan Mar 17, 2020
d3775d7
Merge branch 'master' into patch-2
axgillies Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/python/guides/flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,12 @@ flags have other arguments, which are described with the flag.
takes optional arguments `lower_bound` and `upper_bound` as for floats.
* `DEFINE_enum`: takes a list of strings that represents legal values. If the
command-line value is not in this list, it raises a flag error; otherwise,
it assigns to `FLAGS.flag` as a string.
* `DEFINE_list`: Takes a comma-separated list of strings on the command line
it assigns to `FLAGS.flag` as a string. If possible, use `DEFINE_enum_class`
instead.
* `DEFINE_enum_class`: takes an `enum.Enum` that represents legal values. If the
command-line value is not a member of the enumeration, it raises a flag
error; otherwise, it assigns the value of the member to `FLAGS.flag`.
* `DEFINE_list`: takes a comma-separated list of strings on the command line
and stores them in a Python list object.
* `DEFINE_spaceseplist`: Takes a space-separated list of strings on the
commandline and stores them in a Python list object. For example:
Expand Down