diff options
| author | Ian Wienand <iwienand@redhat.com> | 2014-11-04 16:00:10 +1100 |
|---|---|---|
| committer | Ian Wienand <iwienand@redhat.com> | 2015-02-12 11:06:54 +1100 |
| commit | 22413532bfe87bd61e0cc548f6234e6bca36b06b (patch) | |
| tree | 582c3cada30f68099d308d91bbedbbff0c05fbf3 /doc | |
| parent | 28fd2cc531adf2b10b3a3423bd9fbaa3a265ccd7 (diff) | |
| download | oslo-config-22413532bfe87bd61e0cc548f6234e6bca36b06b.tar.gz | |
Clear up MultiStrOpt and related documentation1.6.1
For a person entering documentation wondering what MultiStrOpt
semantics are, the existing documentation isn't much help.
Without an explanation of its parent class MultiOpt, MultiStringOpt
doesn't make much sense. The "kept for backwards-compatibility" is
also rather confusing as it makes not mention why.
This adds MultiOpt to the documentation and explains its role. I
couldn't see where it was being tested at all, so some minimal
test-cases are added for MultiOpt.
The other options are brought into line with the updated MultiStrOpt,
giving a link to the type they pass to Opt() and a better
backwards-compatibility message.
The Option Types section is also clarified a bit, and includes links
to relevant places.
Change-Id: Iae65ffd31e7319938f03d120b3ed3ad55f2dbcaf
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/opts.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/source/opts.rst b/doc/source/opts.rst index de9b834..4676350 100644 --- a/doc/source/opts.rst +++ b/doc/source/opts.rst @@ -11,6 +11,7 @@ Option Definitions .. autoclass:: FloatOpt .. autoclass:: ListOpt .. autoclass:: DictOpt +.. autoclass:: MultiOpt .. autoclass:: MultiStrOpt .. autoclass:: IPOpt .. autoclass:: DeprecatedOpt |