bc9b7f5d2f
Nova uses a common pattern for choices where a 'choices' parameter is provided and the choices are later documented in the help text. This frequently leads to code and docs getting out-of-sync and requires authors to be consistent in how they write option descriptions. Eliminate the need to do this by allowing users to describe the choices in the same place as the choices are declared. Change-Id: Ic084b04ebf232fb72c9c05bbea3a216391b15c83
15 lines
606 B
YAML
15 lines
606 B
YAML
---
|
|
features:
|
|
- |
|
|
String, Number, Integer, Float and Port now support value-description
|
|
tuples in the interable provided for the *choice* parameter. Support for
|
|
value-only definitions is retained.
|
|
- |
|
|
StringOpt and PortOpt now support a value-description tuples in the
|
|
iterable provided for the *choice* parameter. Support for value-only
|
|
definitions is retained.
|
|
- |
|
|
*oslo-config-generator* and the Sphinx extension will now output
|
|
descriptions for option choices where provided. This will impact tooling
|
|
that relies on the *yaml* and *json* output of the former.
|