diff options
| author | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-01-31 08:35:51 -0800 |
|---|---|---|
| committer | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-01-31 14:35:47 -0800 |
| commit | 1fdfb3b8a1ba9d0806fd2cce98b464a337aef11d (patch) | |
| tree | 1c50386dd264c695268ce2d2dbcbd0b42b67bbb0 /oslo/config/types.py | |
| parent | 16541c554e43b9291a74cfd7a5313e6482f4da77 (diff) | |
| download | oslo-config-1fdfb3b8a1ba9d0806fd2cce98b464a337aef11d.tar.gz | |
Add docs for types
Add a page to pull in the docstrings for the option types,
and make the docstring changes in the module necessary for
that to work properly.
Also fix a formatting issue in the docs for the cfg module.
Change-Id: Ib1cf24e59ecc3592d3b703f99659f4a0fdbc7f5c
Diffstat (limited to 'oslo/config/types.py')
| -rw-r--r-- | oslo/config/types.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/oslo/config/types.py b/oslo/config/types.py index bd80024..67fcd30 100644 --- a/oslo/config/types.py +++ b/oslo/config/types.py @@ -14,6 +14,13 @@ # License for the specific language governing permissions and limitations # under the License. +"""Type conversion and validation classes for configuration options. + +Use these classes as values for the `type` argument to +:class:`oslo.config.cfg.Opt` and its subclasses. + +""" + class String(object): |