diff options
| author | Stephen Finucane <stephenfin@redhat.com> | 2019-09-30 14:31:30 +0100 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2019-10-01 19:14:55 +0200 |
| commit | 0863f04a2673cb92934a509ca689a9b06441286a (patch) | |
| tree | 78abc2336ddc7c47f234cb1c14b93b3bf7a2efcb /tox.ini | |
| parent | 79f387fbd5fde9e671dd32684f73dbf3451379dc (diff) | |
| download | python-barbicanclient-0863f04a2673cb92934a509ca689a9b06441286a.tar.gz | |
docs: Turn on warning-as-error
There were two main issues here. Firstly, a function was being
documented as a class, resulting in:
WARNING: error while formatting arguments for barbicanclient.client.Client:
'function' object has no attribute '__mro__'
Secondly, a docstring for a common function had an incorrect field list
format, resulting in:
docstring of barbicanclient.v1.acls.SecretACL.get:4: WARNING: Field list
ends without a blank line; unexpected unindent
docstring of barbicanclient.v1.acls.ContainerACL.get:4: WARNING: Field list
ends without a blank line; unexpected unindent
Resolve both.
Change-Id: I69ef97cb48c6b5a1add4e89c4a53047420d314f4
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -42,7 +42,7 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} -r{toxinidir}/requirements.txt -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -b html doc/source doc/build/html +commands = sphinx-build -b html -W doc/source doc/build/html [testenv:functional] # This tox env is purely to make local test development easier |