aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.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/HcAPIKwBridgeDomain.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/HcAPIKwBridgeDomain.py')
-rw-r--r--resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py66
1 files changed, 33 insertions, 33 deletions
diff --git a/resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py b/resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py
index 3c629c96e4..576124794c 100644
--- a/resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py
+++ b/resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 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:
@@ -52,10 +52,10 @@ class BridgeDomainKeywords(object):
:type bd_name: str
:type data: dict
:type data_representation: DataRepresentation
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If the status code in response on PUT is not
- 200 = OK.
+ 200 = OK.
"""
status_code, resp = HcUtil.\
@@ -78,12 +78,12 @@ class BridgeDomainKeywords(object):
:param bd_name: The name of bridge domain.
:param path: Path to data we want to change, create or remove.
:param new_value: The new value to be set. If None, the item will be
- removed.
+ removed.
:type node: dict
:type bd_name: str
:type path: tuple
:type new_value: str, dict or list
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If it is not possible to get or set the data.
"""
@@ -109,10 +109,10 @@ class BridgeDomainKeywords(object):
:param bd_name: Bridge domain name.
:param kwargs: Parameters and their values. The accepted parameters are
- defined in BridgeDomainKeywords.PARAMS.
+ defined in BridgeDomainKeywords.PARAMS.
:type bd_name: str
:type kwargs: dict
- :return: Bridge domain data structure.
+ :returns: Bridge domain data structure.
:rtype: dict
"""
@@ -132,7 +132,7 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:type node: dict
- :return: Configuration data about all bridge domains from Honeycomb.
+ :returns: Configuration data about all bridge domains from Honeycomb.
:rtype: list
:raises HoneycombError: If it is not possible to get configuration data.
"""
@@ -157,8 +157,8 @@ class BridgeDomainKeywords(object):
:param bd_name: The name of bridge domain.
:type node: dict
:type bd_name: str
- :return: Configuration data about the given bridge domain from
- Honeycomb.
+ :returns: Configuration data about the given bridge domain from
+ Honeycomb.
:rtype: dict
"""
@@ -174,7 +174,7 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:type node: dict
- :return: Operational data about all bridge domains from Honeycomb.
+ :returns: Operational data about all bridge domains from Honeycomb.
:rtype: list
:raises HoneycombError: If it is not possible to get operational data.
"""
@@ -199,7 +199,7 @@ class BridgeDomainKeywords(object):
:param bd_name: The name of bridge domain.
:type node: dict
:type bd_name: str
- :return: Operational data about the given bridge domain from Honeycomb.
+ :returns: Operational data about the given bridge domain from Honeycomb.
:rtype: dict
"""
@@ -218,11 +218,11 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:param bd_name: Bridge domain name.
:param kwargs: Parameters and their values. The accepted parameters are
- defined in BridgeDomainKeywords.PARAMS
+ defined in BridgeDomainKeywords.PARAMS
:type node: dict
:type bd_name: str
:type kwargs: dict
- :return: Bridge domain data structure.
+ :returns: Bridge domain data structure.
:rtype: dict
"""
@@ -237,11 +237,11 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:param bd_name: Bridge domain name.
:param kwargs: Parameters and their values. The accepted parameters are
- defined in BridgeDomainKeywords.PARAMS
+ defined in BridgeDomainKeywords.PARAMS
:type node: dict
:type bd_name: str
:type kwargs: dict
- :return: Bridge domain data structure.
+ :returns: Bridge domain data structure.
:rtype: dict
"""
@@ -257,10 +257,10 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:type node: dict
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If it is not possible to remove all bridge
- domains.
+ domains.
"""
data = {"bridge-domains": {"bridge-domain": []}}
@@ -281,10 +281,10 @@ class BridgeDomainKeywords(object):
:param bd_name: The name of bridge domain to be removed.
:type node: dict
:type bd_name: str
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
- :raises HoneycombError:If it is not possible to remove the bridge
- domain.
+ :raises HoneycombError: If it is not possible to remove the bridge
+ domain.
"""
path = ("bridge-domains", ("bridge-domain", "name", bd_name))
@@ -312,14 +312,14 @@ class BridgeDomainKeywords(object):
:param node: Honeycomb node.
:param bd_name: Bridge domain name.
:param param: Parameter to set, change or remove. The accepted
- parameters are defined in BridgeDomainKeywords.PARAMS
+ parameters are defined in BridgeDomainKeywords.PARAMS
:param value: The new value to be set, change or remove. If None, the
- item will be removed.
+ item will be removed.
:type node: dict
:type bd_name: str
:type param: str
:type value: str
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
"""
@@ -340,7 +340,7 @@ class BridgeDomainKeywords(object):
:type node: dict
:type bd_name: str
:type l2_fib_entry: dict
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
"""
@@ -368,7 +368,7 @@ class BridgeDomainKeywords(object):
:type mac: str
:type param: str
:type value: str or int
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
"""
@@ -392,10 +392,10 @@ class BridgeDomainKeywords(object):
:type node: dict
:type bd_name: str
:type mac: str
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
:raises HoneycombError: If it is not possible to remove the specified
- entry.
+ entry.
"""
path = ("bridge-domains",
@@ -429,7 +429,7 @@ class BridgeDomainKeywords(object):
:param bd_name: Bridge domain's name.
:type node: dict
:type bd_name: str
- :return: Content of response.
+ :returns: Content of response.
:rtype: bytearray
"""
@@ -448,8 +448,8 @@ class BridgeDomainKeywords(object):
:param bd_name: Bridge domain's name.
:type node: dict
:type bd_name: str
- :return: Bridge domain's L2 FIB table or empty list if the table does
- not exist or it is empty.
+ :returns: Bridge domain's L2 FIB table or empty list if the table does
+ not exist or it is empty.
:rtype: list
"""
@@ -470,8 +470,8 @@ class BridgeDomainKeywords(object):
:type node: dict
:type bd_name: str
:type mac: str
- :return: The requested entry from bridge domain's L2 FIB table or empty
- dictionary if it does not exist in the L2 FIB table.
+ :returns: The requested entry from bridge domain's L2 FIB table or empty
+ dictionary if it does not exist in the L2 FIB table.
:rtype: dict
"""