Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation clarity: remove *args, **kwords #88

Open
VikingScientist opened this issue Dec 11, 2018 · 0 comments
Open

Documentation clarity: remove *args, **kwords #88

VikingScientist opened this issue Dec 11, 2018 · 0 comments

Comments

@VikingScientist
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant