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/L2Util.py | 31 ++++++++++++++++---------------
 1 file changed, 16 insertions(+), 15 deletions(-)

(limited to 'resources/libraries/python/L2Util.py')

diff --git a/resources/libraries/python/L2Util.py b/resources/libraries/python/L2Util.py
index 6b8bc042e3..7954193b60 100644
--- a/resources/libraries/python/L2Util.py
+++ b/resources/libraries/python/L2Util.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:
@@ -92,7 +92,7 @@ class L2Util(object):
         :type uu_flood: bool
         :type forward: bool
         :type learn: bool
-        :type arp_term:bool
+        :type arp_term: bool
         """
         VatExecutor.cmd_from_template(node, "l2_bd_create.vat",
                                       bd_id=bd_id, flood=flood,
@@ -132,7 +132,7 @@ class L2Util(object):
         :type sw_if_index: int
         :type bd_id: int
         :type shg: int
-        :return:
+        :returns: None
         """
         VatExecutor.cmd_from_template(node, "l2_bd_add_sw_if_index.vat",
                                       bd_id=bd_id, sw_if_index=sw_if_index,
@@ -151,12 +151,12 @@ class L2Util(object):
 
         :param node: Node data dictionary.
         :param link_names: List of names of links the bridge domain should be
-        connecting.
+            connecting.
         :param bd_id: Bridge domain index number.
         :type node: dict
         :type link_names: list
-        :return: Dictionary used to generate l2 bridge domain VAT configuration
-        from template file.
+        :returns: Dictionary used to generate l2 bridge domain VAT configuration
+            from template file.
         :rtype: dict
         """
         bd_dict = Topology().get_interfaces_by_link_names(node, link_names)
@@ -226,7 +226,7 @@ class L2Util(object):
         :param if_1: First interface to be added to the bridge.
         :param if_2: Second interface to be added to the bridge.
         :param set_up: Change bridge interface state to up after create bridge.
-        Optional. Default: True.
+            Optional. Default: True.
         :type node: dict
         :type br_name: str
         :type if_1: str
@@ -247,15 +247,16 @@ class L2Util(object):
     def linux_del_bridge(node, br_name, set_down=True):
         """Delete bridge from linux node.
 
+        ..note:: The network interface corresponding to the bridge must be
+            down before it can be deleted!
+
         :param node: Node to delete bridge from.
         :param br_name: Bridge name.
         :param set_down: Change bridge interface state to down before delbr
-        command. Optional. Default: True.
+            command. Optional. Default: True.
         :type node: str
         :type br_name: str
         :type set_down: bool
-        ..note:: The network interface corresponding to the bridge must be
-        down before it can be deleted!
         """
         if set_down:
             cmd = 'ip link set dev {0} down'.format(br_name)
@@ -272,8 +273,8 @@ class L2Util(object):
         :param bd_id: Numeric ID of a specific bridge domain.
         :type node: dict
         :type bd_id: int
-        :return: List of dictionaries containing data for each bridge domain, or
-         a single dictionary for the specified bridge domain.
+        :returns: List of dictionaries containing data for each bridge domain,
+            or a single dictionary for the specified bridge domain.
         :rtype: list or dict
         """
         with VatTerminal(node) as vat:
@@ -298,7 +299,7 @@ class L2Util(object):
         :param interface: Interface on which rewrite tags.
         :param tag_rewrite_method: Method of tag rewrite.
         :param push_dot1q: Optional parameter to disable to push dot1q tag
-         instead of dot1ad.
+            instead of dot1ad.
         :param tag1_id: Optional tag1 ID for VLAN.
         :param tag2_id: Optional tag2 ID for VLAN.
         :type node: dict
@@ -367,7 +368,7 @@ class L2Util(object):
         :param bd_index: Index of the bridge domain.
         :type node: dict
         :type bd_index: int
-        :return: L2 FIB table.
+        :returns: L2 FIB table.
         :rtype: list
         """
 
@@ -393,7 +394,7 @@ class L2Util(object):
         :type node: dict
         :type bd_index: int
         :type mac: str
-        :return: L2 FIB entry
+        :returns: L2 FIB entry
         :rtype: dict
         """
 
-- 
cgit 1.2.3-korg