aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/telemetry
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/telemetry
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/telemetry')
-rw-r--r--resources/libraries/python/telemetry/IPFIXSetup.py22
-rw-r--r--resources/libraries/python/telemetry/SPAN.py6
2 files changed, 14 insertions, 14 deletions
diff --git a/resources/libraries/python/telemetry/IPFIXSetup.py b/resources/libraries/python/telemetry/IPFIXSetup.py
index f0f35f3bc6..db703c8a7e 100644
--- a/resources/libraries/python/telemetry/IPFIXSetup.py
+++ b/resources/libraries/python/telemetry/IPFIXSetup.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:
@@ -95,7 +95,7 @@ class IPFIXSetup(object):
:param node: DUT node.
:param domain: Desired index number of exporting domain.
:param src_port: Source port to use when sending IPFIX packets. Default
- is the standard IPFIX port 4739.
+ is the standard IPFIX port 4739.
:type node: dict
:type domain: int
:type src_port: int
@@ -112,15 +112,15 @@ class IPFIXSetup(object):
@staticmethod
def assign_classify_table_to_exporter(node, table_id, ip_version='ip4'):
"""Assign a classify table to an IPFIX exporter. Classified packets will
- be included in the IPFIX flow report.
-
- :param node: DUT node.
- :param table_id: ID of a classify table.
- :param ip_version: Version of IP protocol. Valid options are ip4, ip6.
- :type node: dict
- :type table_id: int
- :type ip_version: str
- """
+ be included in the IPFIX flow report.
+
+ :param node: DUT node.
+ :param table_id: ID of a classify table.
+ :param ip_version: Version of IP protocol. Valid options are ip4, ip6.
+ :type node: dict
+ :type table_id: int
+ :type ip_version: str
+ """
with VatTerminal(node, json_param=False) as vat:
vat.vat_terminal_exec_cmd_from_template("ipfix_table_add.vat",
diff --git a/resources/libraries/python/telemetry/SPAN.py b/resources/libraries/python/telemetry/SPAN.py
index 41ff7d34f1..048e89ba67 100644
--- a/resources/libraries/python/telemetry/SPAN.py
+++ b/resources/libraries/python/telemetry/SPAN.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:
@@ -51,7 +51,7 @@ class SPAN(object):
:param node: DUT node.
:type node: dict
:returns: Full SPAN configuration as list. One list entry for every
- source/destination interface pair.
+ source/destination interface pair.
:rtype: list of dict
"""
@@ -72,7 +72,7 @@ class SPAN(object):
:type dst_interface: str or int
:type ret_format: string
:returns: List of SPAN source interfaces for the provided destination
- interface.
+ interface.
:rtype: list
"""