diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-29 17:39:22 -0400 |
|---|---|---|
| committer | Trevor McCasland <TM2086@att.com> | 2017-07-13 10:39:32 -0500 |
| commit | e8d306fa2a72f820055eb76d5b9c155dd0e4008e (patch) | |
| tree | 249640f3715a6249670e1a89fb523ab1753dd232 /troveclient/utils.py | |
| parent | 5ff9b6183ed68b9006dbc904abe7a3567d8a55b5 (diff) | |
| download | python-troveclient-e8d306fa2a72f820055eb76d5b9c155dd0e4008e.tar.gz | |
turn on warning-is-error for documentation builds
Fix a bunch of formatting issues with docstrings to allow us to turn on
the flag that treats warnings as errors to avoid mal-formed
documentation in the future.
Change-Id: Ic6fb73031e37314c49c41e4621dfd92b9c3f59d5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'troveclient/utils.py')
| -rw-r--r-- | troveclient/utils.py | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/troveclient/utils.py b/troveclient/utils.py index 6121656..69e0b3d 100644 --- a/troveclient/utils.py +++ b/troveclient/utils.py @@ -67,10 +67,12 @@ def add_arg(f, *args, **kwargs): def unauthenticated(f): """Adds 'unauthenticated' attribute to decorated function. - Usage: + Usage:: + @unauthenticated def mymethod(f): ... + """ f.unauthenticated = True return f @@ -89,10 +91,12 @@ def isunauthenticated(f): def service_type(stype): """Adds 'service_type' attribute to decorated function. - Usage: + Usage:: + @service_type('database') def mymethod(f): ... + """ def inner(f): f.service_type = stype |