Fix warnings reported by gen_doc.sh 80/11580/10
authorVratko Polak <vrpolak@cisco.com>
Fri, 13 Apr 2018 17:45:33 +0000 (19:45 +0200)
committerPeter Mikus <pmikus@cisco.com>
Wed, 25 Apr 2018 08:47:31 +0000 (08:47 +0000)
commit4c6fe5602edcbd9857a846e5b13a21d5c671a2c8
treeb360a3e65094f9fe542451a747132ff24663b115
parent59e06f5e3143bf093bdb6b53c0186b050668e3d4
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>
57 files changed:
resources/libraries/python/Classify.py
resources/libraries/python/ContainerUtils.py
resources/libraries/python/CpuUtils.py
resources/libraries/python/DPDK/L3fwdTest.py
resources/libraries/python/DUTSetup.py
resources/libraries/python/DpdkUtil.py
resources/libraries/python/DropRateSearch.py
resources/libraries/python/HTTPRequest.py
resources/libraries/python/IPsecUtil.py
resources/libraries/python/IPv4NodeAddress.py
resources/libraries/python/IPv4Setup.py
resources/libraries/python/IPv4Util.py
resources/libraries/python/IPv6Setup.py
resources/libraries/python/IPv6Util.py
resources/libraries/python/InterfaceUtil.py
resources/libraries/python/KubernetesUtils.py
resources/libraries/python/L2Util.py
resources/libraries/python/LispUtil.py
resources/libraries/python/MacSwap.py
resources/libraries/python/Map.py
resources/libraries/python/NATUtil.py
resources/libraries/python/NodePath.py
resources/libraries/python/PacketVerifier.py
resources/libraries/python/Policer.py
resources/libraries/python/QemuUtils.py
resources/libraries/python/Routing.py
resources/libraries/python/SFC/SetupSFCTest.py
resources/libraries/python/TLDK/SetupTLDKTest.py
resources/libraries/python/Tap.py
resources/libraries/python/TrafficGenerator.py
resources/libraries/python/TrafficScriptArg.py
resources/libraries/python/TrafficScriptExecutor.py
resources/libraries/python/VPPUtil.py
resources/libraries/python/VatExecutor.py
resources/libraries/python/VatJsonUtil.py
resources/libraries/python/honeycomb/BGP.py
resources/libraries/python/honeycomb/DHCP.py
resources/libraries/python/honeycomb/HcAPIKwACL.py
resources/libraries/python/honeycomb/HcAPIKwBridgeDomain.py
resources/libraries/python/honeycomb/HcAPIKwInterfaces.py
resources/libraries/python/honeycomb/HcAPIKwNSH.py
resources/libraries/python/honeycomb/HcPersistence.py
resources/libraries/python/honeycomb/HoneycombSetup.py
resources/libraries/python/honeycomb/HoneycombUtil.py
resources/libraries/python/honeycomb/Lisp.py
resources/libraries/python/honeycomb/NAT.py
resources/libraries/python/honeycomb/Netconf.py
resources/libraries/python/honeycomb/Notifications.py
resources/libraries/python/honeycomb/Performance.py
resources/libraries/python/honeycomb/ProxyARP.py
resources/libraries/python/honeycomb/Routing.py
resources/libraries/python/parsers/JsonParser.py
resources/libraries/python/ssh.py
resources/libraries/python/tcp.py
resources/libraries/python/telemetry/IPFIXSetup.py
resources/libraries/python/telemetry/SPAN.py
resources/libraries/python/topology.py

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.