From 2d267819923423d7cfb447e1e23b04eb2696a04d Mon Sep 17 00:00:00 2001
From: Karol Gugala <kgugala@antmicro.com>
Date: Mon, 17 Jun 2019 11:44:54 +0200
Subject: [PATCH] fuzzers: 007: tim2json: update docstrings

Signed-off-by: Karol Gugala <kgugala@antmicro.com>
---
 fuzzers/007-timing/bel/tim2json.py | 66 ++++++++++++++++++++++--------
 1 file changed, 50 insertions(+), 16 deletions(-)

diff --git a/fuzzers/007-timing/bel/tim2json.py b/fuzzers/007-timing/bel/tim2json.py
index ac020092..bddf8723 100644
--- a/fuzzers/007-timing/bel/tim2json.py
+++ b/fuzzers/007-timing/bel/tim2json.py
@@ -49,16 +49,24 @@ def find_aliased_pin(pin, model, pin_aliases):
     """
     Searches for aliased pins
 
-    Args:
-        pin: pin name to look for
-        model: timing model string
-        pin_aliases: A dict of list of aliases for given bel/site
+    Parameters
+    ----------
+        pin: str
+            Pin name to look for
+        model: str
+            Timing model
+        pin_aliases: dict
+            A dict of list of aliases for given bel/site
 
-    Returns:
-        is_pin_aliased: Bool
-        new_pin_name: string
-        If pin is found in the alias list the function returs a
-        new pin name which should be used in further processing
+    Returns
+    -------
+        bool, str
+
+        The first bool value is set to true if pin is found
+        in the timing model, false otherwise.
+
+        The second returned value is found pin name. If pin
+        is not found None is returned
 
     >>> find_aliased_pin("a", "a_b_some_test_string", None)
     (False, None)
@@ -93,14 +101,26 @@ def pin_in_model(pin, pin_aliases, model, direction=None):
     """
     Checks if a given pin belongs to the model.
 
-    Args:
-        pin: Pin name to look for
-        pin_aliases: A dict of list of aliases for given bel/site
-        model: Model name string
-        direction: Optional pin direction suffix
+    Parameters
+    ----------
+        pin: str
+            Pin name to look for
+        pin_aliases: dict
+            A dict of list of aliases for given bel/site
+        model: str
+            Timing model name
+        direction: str
+            Optional pin direction suffix [IN|OUT]
 
-    Returns:
-        is_pin_in_model, pin_name
+    Returns
+    -------
+        bool, str
+
+        The first returned value is set to true if pin is found,
+        false otherwise.
+
+        The second returned value contains found pin name. If the
+        pin is not found, None is returned.
 
     >>> pin_in_model("d", None, "ff_init_din_q", "in")
     (True, 'din')
@@ -157,6 +177,20 @@ def remove_pin_from_model(pin, model):
     """
     Removes the pin from model name if present.
 
+    Arguments
+    ---------
+
+    pin: str
+        Pin name
+    mode: str
+        Timing model name
+
+    Returns
+    -------
+
+    str
+        Updated timing model name
+
     >>> remove_pin_from_model("q", "ff_init_d_q")
     'ff_init_d'
     >>> remove_pin_from_model("q", "ff_init_d_ql")