diff options
| author | Jay Faulkner <jay@jvf.cc> | 2015-03-31 15:41:57 -0700 |
|---|---|---|
| committer | Jay Faulkner <jay@jvf.cc> | 2015-03-31 16:22:57 -0700 |
| commit | 8bad5bbac3fd980e726cd67e0a8dadef40d6e4ec (patch) | |
| tree | a341be296afa6f2563e74d89dfb7765dafa50d25 /ironic_python_agent/api | |
| parent | be975259758f8c58e5b6c72ff99878579aa9b37d (diff) | |
| download | ironic-python-agent-8bad5bbac3fd980e726cd67e0a8dadef40d6e4ec.tar.gz | |
Fix Sphinx Autodoc WARNING/ERROR in docs build
The docstrings here were all giving WARNINGs or ERRORs during the docs
build, and were generally making unappealing looking developer
documentation. I corrected the syntax and did what was neccessary to
make the build come out clean.
Change-Id: I74b00a7f125770b0468cff3bdf26d0d52cd054d7
(cherry picked from commit c0921cdff372ce1fd6df1c4ab4eb5463e2cba0e4)
Diffstat (limited to 'ironic_python_agent/api')
| -rw-r--r-- | ironic_python_agent/api/controllers/v1/base.py | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/ironic_python_agent/api/controllers/v1/base.py b/ironic_python_agent/api/controllers/v1/base.py index 20af8964..769f819b 100644 --- a/ironic_python_agent/api/controllers/v1/base.py +++ b/ironic_python_agent/api/controllers/v1/base.py @@ -1,16 +1,16 @@ # All Rights Reserved. # -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. import six from wsme import types as wtypes @@ -45,7 +45,7 @@ class MultiType(wtypes.UserType): Used for validating that a value is an instance of one of the types. - :param *types: Variable-length list of types. + :param \*types: Variable-length list of types. """ def __init__(self, *types): |