We have a bunch of different docstring styles used in the various definitions.
Some directly come from the __doc__ property of the wrapper functions generated by f2py, recognizable by the bounds qualifier.
|
Ar : output rank-2 array('d') with bounds (n,n) |
Other functions use shape()
|
A_z : rank-2 array('d'), shape (n,n) |
Sometimes we have blank space between the parameter definitions. Sometimes not.
What's your opinion on unifying this? Adhere to numpydoc and get closer to the documentation in numpy and scipy? Decide on a proper way to specify the shape?
The array('d') is also not consistent with numpydoc, I guess.
Would also affect the math formulas.
We have a bunch of different docstring styles used in the various definitions.
Some directly come from the
__doc__property of the wrapper functions generated by f2py, recognizable by theboundsqualifier.Slycot/slycot/math.py
Line 104 in 196e4ec
Other functions use
shape()Slycot/slycot/synthesis.py
Line 74 in 196e4ec
Sometimes we have blank space between the parameter definitions. Sometimes not.
What's your opinion on unifying this? Adhere to numpydoc and get closer to the documentation in numpy and scipy? Decide on a proper way to specify the shape?
The array('d') is also not consistent with numpydoc, I guess.
Would also affect the math formulas.