You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
classSurface(SplineObject):
defevaluate(self, u, v, tensor=True):
""" Insert some documentation text here, but the main documentation point is the method signature """returnsuper(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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: