aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/TrafficScriptExecutor.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/TrafficScriptExecutor.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/TrafficScriptExecutor.py')
-rw-r--r--resources/libraries/python/TrafficScriptExecutor.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/resources/libraries/python/TrafficScriptExecutor.py b/resources/libraries/python/TrafficScriptExecutor.py
index 13696dee8d..db5e434b42 100644
--- a/resources/libraries/python/TrafficScriptExecutor.py
+++ b/resources/libraries/python/TrafficScriptExecutor.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:
@@ -28,7 +28,7 @@ class TrafficScriptExecutor(object):
:param string: String to escape.
:type string: str
- :return: Escaped string.
+ :returns: Escaped string.
:rtype: str
"""
return string.replace('"', '\\"').replace("$", "\\$")
@@ -97,7 +97,7 @@ class TrafficScriptExecutor(object):
:type dst_mac: str
:type src_ip: str
:type dst_ip: str
- :return: Traffic script arguments string.
+ :returns: Traffic script arguments string.
:rtype: str
"""
args = ('--rx_if {0} --tx_if {1} --src_mac {2} --dst_mac {3} --src_ip'