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/SFC | |
| 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/SFC')
| -rw-r--r-- | resources/libraries/python/SFC/SetupSFCTest.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/resources/libraries/python/SFC/SetupSFCTest.py b/resources/libraries/python/SFC/SetupSFCTest.py index a1d99c5cc6..0ba197115d 100644 --- a/resources/libraries/python/SFC/SetupSFCTest.py +++ b/resources/libraries/python/SFC/SetupSFCTest.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: @@ -38,7 +38,7 @@ def pack_framework_dir(): :returns: the temporary package file name. :rtype: str - :raises: If execute the tar command failed. + :raises RuntimeError: If execute the tar command failed. """ tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="SFC-testing-") @@ -86,7 +86,7 @@ def extract_tarball_at_node(tarball, node): :type tarball: str :type node: dict :returns: nothing - :raises: If unpack the file failed. + :raises RuntimeError: If unpack the file failed. """ logger.console('Extracting tarball to {0} on {1}'.format( con.REMOTE_FW_DIR, node['host'])) |