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/IPv6Util.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'resources/libraries/python/IPv6Util.py') diff --git a/resources/libraries/python/IPv6Util.py b/resources/libraries/python/IPv6Util.py index 1aab1816f2..f89d17169b 100644 --- a/resources/libraries/python/IPv6Util.py +++ b/resources/libraries/python/IPv6Util.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: @@ -37,7 +37,7 @@ class IPv6Util(object): :type count: int :type data_size: int :type timeout: int - :return: Number of lost packets. + :returns: Number of lost packets. :rtype: int """ ssh = SSH() @@ -74,7 +74,7 @@ class IPv6Util(object): :type cnt: int :type size: int :type timeout: int - :return: Number of lost packets. + :returns: Number of lost packets. :rtype: int """ dst_ip = IPv6Util.get_node_port_ipv6_address(dst_node, port, nodes_ip) @@ -90,7 +90,7 @@ class IPv6Util(object): :type node: dict :type iface_key: str :type nodes_addr: dict - :return: IPv6 address string. + :returns: IPv6 address string. :rtype: str """ interface = Topology.get_interface_name(node, iface_key) -- cgit 1.2.3-korg