From 4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 Mon Sep 17 00:00:00 2001 From: Vratko Polak Date: Fri, 13 Apr 2018 19:45:33 +0200 Subject: 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 --- resources/libraries/python/TrafficScriptExecutor.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'resources/libraries/python/TrafficScriptExecutor.py') 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' -- cgit 1.2.3-korg