enums.either

enums.either(option, quote='`')

The option set as a prose alternative, in declaration order.

Parameters

Name Type Description Default
option type[StrEnum] A string enum from this module. required
quote str What to wrap each value in; a backtick by default, because the viewer’s rejection messages are read as markdown. '’`

Returns

Name Type Description
str "`thermal` or `elastic`" for two members, and
str "`newton`, `adam`, or `sgd`" for three or more.