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/LispUtil.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/LispUtil.py')
| -rw-r--r-- | resources/libraries/python/LispUtil.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/resources/libraries/python/LispUtil.py b/resources/libraries/python/LispUtil.py index 89f12bb2f2..786dac4b44 100644 --- a/resources/libraries/python/LispUtil.py +++ b/resources/libraries/python/LispUtil.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: @@ -45,7 +45,7 @@ class LispUtil(object): :param node: VPP node. :param items_filter: Filter which specifies which items should be - retrieved - local, remote, empty string = both. + retrieved - local, remote, empty string = both. :type node: dict :type items_filter: str :returns: Lisp locator_set data as python list. @@ -220,7 +220,7 @@ class LispUtil(object): :type node: dict :type locator_set_number: str :returns: list of lisp locator_set, list of lisp locator_set expected - from VAT. + from VAT. :rtype: tuple """ @@ -266,7 +266,7 @@ class LispUtil(object): :type node: dict :type locator_set_number: str :returns: list of lisp locator_set, list of lisp locator_set expected - from VAT. + from VAT. :rtype: tuple """ |