From 4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 Mon Sep 17 00:00:00 2001
From: Vratko Polak <vrpolak@cisco.com>
Date: Fri, 13 Apr 2018 19:45:33 +0200
Subject: 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>
---
 resources/libraries/python/honeycomb/HcAPIKwNSH.py | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'resources/libraries/python/honeycomb/HcAPIKwNSH.py')

diff --git a/resources/libraries/python/honeycomb/HcAPIKwNSH.py b/resources/libraries/python/honeycomb/HcAPIKwNSH.py
index ce60628d83..e042fdd423 100644
--- a/resources/libraries/python/honeycomb/HcAPIKwNSH.py
+++ b/resources/libraries/python/honeycomb/HcAPIKwNSH.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:
@@ -43,10 +43,10 @@ class NSHKeywords(object):
         :type node: dict
         :type path: str
         :type data: dict
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         :raises HoneycombError: If the status code in response to PUT is not
-        OK or ACCEPTED.
+            OK or ACCEPTED.
         """
 
         if data:
@@ -74,7 +74,7 @@ class NSHKeywords(object):
         :type node: dict
         :type name: str
         :type data: dict
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         """
 
@@ -93,7 +93,7 @@ class NSHKeywords(object):
         :type node: dict
         :type name: str
         :type data: dict
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         """
         path = "/nsh-maps/nsh-map/{0}".format(name)
@@ -107,7 +107,7 @@ class NSHKeywords(object):
         :param name: Name of the NSH entry.
         :type node: dict
         :type name: str
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         """
 
@@ -121,7 +121,7 @@ class NSHKeywords(object):
         :param name: Name of the NSH map.
         :type node: dict
         :type name: str
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         """
 
@@ -136,11 +136,11 @@ class NSHKeywords(object):
         :param node: Honeycomb node.
         :param entry_name: Name of a specific NSH entry. Optional.
         :param map_name: Name of a specific NSH map. Optional. Do not use
-        together with entry_name.
+            together with entry_name.
         :type node: dict
         :type entry_name: str
         :type map_name: str
-        :return: List of classify tables.
+        :returns: List of classify tables.
         :rtype: list
         """
         if entry_name:
@@ -166,7 +166,7 @@ class NSHKeywords(object):
 
         :param node: Honeycomb node.
         :type node: dict
-        :return: Content of response.
+        :returns: Content of response.
         :rtype: bytearray
         """
 
-- 
cgit 1.2.3-korg