example_numpydoc.py.patch

# Patch generated by Pyment v0.4.0dev

--- a/example.py
+++ b/example.py
@@ -1,54 +1,108 @@
 def func1(param1: str, param2='default val'):
-    '''Description of func with docstring javadoc style.
+    """Description of func with docstring javadoc style.
 
-    @param param1: descr of param
-    @type param1: type
-    @return: some value
-    @raise KeyError: raises a key exception
+    Parameters
+    ----------
+    param1 : str
+        descr of param
+    param2 :
+         (Default value = 'default val')
 
-    '''
+    Returns
+    -------
+    type
+        some value
+
+    Raises
+    ------
+    KeyError
+        raises a key exception
+
+    """
     pass
 
 def func2(param1, param2='default val2') -> list:
-    '''Description of func with docstring reST style.
+    """Description of func with docstring reST style.
 
-    :param param1: descr of param
-    :type param1: type
-    :returns: some value
-    :raises keyError: raises exception
+    Parameters
+    ----------
+    param1 : type
+        descr of param
+    param2 :
+         (Default value = 'default val2')
 
-    '''
+    Returns
+    -------
+    list
+        some value
+
+    Raises
+    ------
+    keyError
+        raises exception
+
+    """
     pass
 
 def func3(param1, param2='default val'):
-    '''Description of func with docstring groups style.
+    """Description of func with docstring groups style.
 
-    Params: 
-        param1 - descr of param
+    Parameters
+    ----------
+    param1 :
+        descr of param
+    param2 :
+         (Default value = 'default val')
 
-    Returns:
+    Returns
+    -------
+    type
         some value
 
-    Raises:
-        keyError: raises key exception
-        TypeError: raises type exception
+    Raises
+    ------
+    keyError
+        raises key exception
+    TypeError
+        raises type exception
 
-    '''
+    """
     pass
 
 class SomeClass(object):
-    '''My class.
-    '''
+    """My class."""
     def method(self, prm):
-        '''description'''
+        """description
+
+        Parameters
+        ----------
+        prm :
+            
+
+        Returns
+        -------
+
+        """
         pass
 
     def method2(self, prm1, prm2='defaultprm'):
+        """
+
+        Parameters
+        ----------
+        prm1 :
+            
+        prm2 :
+             (Default value = 'defaultprm')
+
+        Returns
+        -------
+
+        """
         pass
 
     def method_numpy(self):
-        """
-        My numpydoc description of a kind
+        """My numpydoc description of a kind
         of very exhautive numpydoc format docstring.
 
         Parameters
@@ -77,27 +131,24 @@
         a_func : linked (optional), with things to say
                  on several lines
         some blabla
-
+        
         Note
         ----
         Some informations.
-
+        
         Some maths also:
         .. math:: f(x) = e^{- x}
-
         References
         ----------
         Biblio with cited ref [1]_. The ref can be cited in Note section.
-
+        
         .. [1] Adel Daouzli, Sylvain Saïghi, Michelle Rudolph, Alain Destexhe,
            Sylvie Renaud: Convergence in an Adaptive Neural Network:
            The Influence of Noise Inputs Correlation. IWANN (1) 2009: 140-148
-
         Examples
         --------
         This is example of use
         >>> print "a"
         a
-
         """
         pass