aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/honeycomb/Lisp.py
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2018-04-13 19:45:33 +0200
committerPeter Mikus <pmikus@cisco.com>2018-04-25 08:47:31 +0000
commit4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 (patch)
treeb360a3e65094f9fe542451a747132ff24663b115 /resources/libraries/python/honeycomb/Lisp.py
parent59e06f5e3143bf093bdb6b53c0186b050668e3d4 (diff)
Fix warnings reported by gen_doc.sh
+ Docstring warnings fixed. + Multiline param descriptions indented by 4 spaces. - Except the PacketVerifier.py one - I have tried several quote-like blocks, nothing works. - Rst warnings not fixed. - How can I fix them? They refer to temporarily created files. + Other improvements: + Python lines no longer than 80 characters. + :return: -> :returns: + Notes before params. + :raises + closing colon after exception class. + Description is a sentence. + Present tense in conditional sentences. + Bumped copyright year in edited files. Change-Id: I462c194eeecb666dc146e26858486a07c990be9b Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/python/honeycomb/Lisp.py')
-rw-r--r--resources/libraries/python/honeycomb/Lisp.py18
1 files changed, 9 insertions, 9 deletions
diff --git a/resources/libraries/python/honeycomb/Lisp.py b/resources/libraries/python/honeycomb/Lisp.py
index f2fe24caf1..6ff6f834cc 100644
--- a/resources/libraries/python/honeycomb/Lisp.py
+++ b/resources/libraries/python/honeycomb/Lisp.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
# 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:
@@ -50,7 +50,7 @@ class LispKeywords(object):
:returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the status code in response to PUT is not
- 200 = OK or 201 = ACCEPTED.
+ 200 = OK or 201 = ACCEPTED.
"""
if data:
@@ -142,7 +142,7 @@ class LispKeywords(object):
:returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the return code is not 200:OK
- or 404:NOT FOUND.
+ or 404:NOT FOUND.
"""
ret_code, data = HcUtil.get_honeycomb_data(node, "config_lisp")
@@ -186,7 +186,7 @@ class LispKeywords(object):
:param interface: An interface on the node.
:param locator_set: Name for the new locator set.
:param priority: Priority parameter for the locator.
- :param weight. Weight parameter for the locator.
+ :param weight: Weight parameter for the locator.
:type node: dict
:type interface: str
:type locator_set: str
@@ -491,7 +491,7 @@ class LispGPEKeywords(object):
:returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the status code in response to PUT is not
- 200 = OK or 201 = ACCEPTED.
+ 200 = OK or 201 = ACCEPTED.
"""
if data:
@@ -518,7 +518,7 @@ class LispGPEKeywords(object):
:returns: LISP GPE operational data.
:rtype: bytearray
:raises HoneycombError: If the status code in response to GET is not
- 200 = OK.
+ 200 = OK.
"""
status_code, resp = HcUtil.get_honeycomb_data(node, "oper_lisp_gpe")
@@ -540,7 +540,7 @@ class LispGPEKeywords(object):
:returns: LISP GPE mapping.
:rtype: dict
:raises HoneycombError: If the mapping is not present in operational
- data.
+ data.
"""
data = LispGPEKeywords.get_lispgpe_operational_data(node)
@@ -568,7 +568,7 @@ class LispGPEKeywords(object):
:returns: LISP GPE config data.
:rtype: bytearray
:raises HoneycombError: If the status code in response to GET is not
- 200 = OK.
+ 200 = OK.
"""
status_code, resp = HcUtil.get_honeycomb_data(node, "config_lisp_gpe")
@@ -590,7 +590,7 @@ class LispGPEKeywords(object):
:returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the return code is not 200:OK
- or 404:NOT FOUND.
+ or 404:NOT FOUND.
"""
ret_code, data = HcUtil.get_honeycomb_data(node, "config_lisp_gpe")