Quite a lot of functions take the arguments (*args, **kwrds), and while they are quite general and applicable, they are incredible cumbersome to read in the documentation.
I suggest that this syntax be avoided as much as possible.
Suggestion 1
Create subclassfunctions just to create a corresponding readable documentation page. I.e.
class Surface(SplineObject):
def evaluate(self, u, v, tensor=True):
""" Insert some documentation text here, but the main documentation point is the method signature """
return super(Surface, self).evaluate(u,v,tensor=tensor)
Suggestion 2
Provide at least one example of every intended version of the method call in the documentation
Quite a lot of functions take the arguments
(*args, **kwrds), and while they are quite general and applicable, they are incredible cumbersome to read in the documentation.I suggest that this syntax be avoided as much as possible.
Suggestion 1
Create subclassfunctions just to create a corresponding readable documentation page. I.e.
Suggestion 2
Provide at least one example of every intended version of the method call in the documentation