diff options
author | Vratko Polak <vrpolak@cisco.com> | 2018-04-13 19:45:33 +0200 |
---|---|---|
committer | Peter Mikus <pmikus@cisco.com> | 2018-04-25 08:47:31 +0000 |
commit | 4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 (patch) | |
tree | b360a3e65094f9fe542451a747132ff24663b115 /resources/libraries/python/IPv4Util.py | |
parent | 59e06f5e3143bf093bdb6b53c0186b050668e3d4 (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/IPv4Util.py')
-rw-r--r-- | resources/libraries/python/IPv4Util.py | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/resources/libraries/python/IPv4Util.py b/resources/libraries/python/IPv4Util.py index 96572f5e1d..fa9d0fe6a9 100644 --- a/resources/libraries/python/IPv4Util.py +++ b/resources/libraries/python/IPv4Util.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: @@ -94,7 +94,7 @@ class IPv4Util(object): :type node: dict :type port: str :type nodes_addr: dict - :return: IPv4 prefix length. + :returns: IPv4 prefix length. :rtype: int """ for net in nodes_addr.values(): @@ -117,7 +117,7 @@ class IPv4Util(object): :type node: dict :type port: int :type nodes_addr: dict - :return: IPv4 subnet. + :returns: IPv4 subnet. :rtype: str """ for net in nodes_addr.values(): @@ -133,9 +133,9 @@ class IPv4Util(object): def flush_ip_addresses(port, node): """See IPv4Node.flush_ip_addresses for more information. - :param port: - :param node: - :return: + :param port: FIXME + :param node: FIXME + :returns: FIXME """ get_node(node).flush_ip_addresses(port) @@ -147,7 +147,7 @@ class IPv4Util(object): :param nodes_addr: Available nodes IPv4 addresses. :type link: str :type nodes_addr: dict - :return: Link IPv4 address. + :returns: Link IPv4 address. :rtype: str """ net = nodes_addr.get(link) @@ -163,7 +163,7 @@ class IPv4Util(object): :param nodes_addr: Available nodes IPv4 addresses. :type link: str :type nodes_addr: dict - :return: Link IPv4 address prefix. + :returns: Link IPv4 address prefix. :rtype: int """ net = nodes_addr.get(link) |