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/NATUtil.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/NATUtil.py')
-rw-r--r-- | resources/libraries/python/NATUtil.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/resources/libraries/python/NATUtil.py b/resources/libraries/python/NATUtil.py index ea13c9411f..ab97e05dcc 100644 --- a/resources/libraries/python/NATUtil.py +++ b/resources/libraries/python/NATUtil.py @@ -1,4 +1,4 @@ -# Copyright (c) 2017 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: @@ -35,7 +35,7 @@ class NATUtil(object): :returns: Response of the command. :rtype: str :raises RuntimeError: If setting of inside and outside interfaces for - NAT44 fails. + NAT44 fails. """ try: @@ -65,7 +65,7 @@ class NATUtil(object): :returns: Response of the command. :rtype: str :raises RuntimeError: If setting of deterministic behaviour of NAT44 - fails. + fails. """ try: @@ -84,8 +84,8 @@ class NATUtil(object): """Set NAT workers. :param node: DUT node. - :param lcores: list of cores, format: range e.g. 1-5 or list of ranges - e.g.: 1-5,18-22. + :param lcores: List of cores, format: range e.g. 1-5 or list of ranges + e.g.: 1-5,18-22. :type node: dict :type lcores: str :returns: Response of the command. @@ -131,7 +131,7 @@ class NATUtil(object): :returns: Response of the command. :rtype: str :raises RuntimeError: If command 'exec snat deterministic forward' - fails. + fails. """ try: @@ -156,7 +156,7 @@ class NATUtil(object): :returns: Response of the command. :rtype: str :raises RuntimeError: If command 'exec snat deterministic reverse' - fails. + fails. """ try: |