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

Cl() is not properly documented #379

Open
arsenovic opened this issue Dec 16, 2020 · 4 comments
Open

Cl() is not properly documented #379

arsenovic opened this issue Dec 16, 2020 · 4 comments

Comments

@arsenovic
Copy link
Member

https://github.com/pygae/clifford/blob/master/clifford/__init__.py#L352

this is possibly the most used function in this package.

@eric-wieser
Copy link
Member

In what sense do you mean "properly"?

@arsenovic
Copy link
Member Author

dont most functions have their parameters listed under

Parameters
-----------------

@eric-wieser
Copy link
Member

That's true, but I think describing p, q, r in the main text works fine anyway. The function is messy to document because it supports multiple unrelated calling conventions...

We should probably at least add an example of each one to the docstring.

https://clifford.readthedocs.io/en/latest/api/clifford.Cl.html#clifford.Cl

@hugohadfield
Copy link
Member

Yeah I think it definitely needs a bit of a flesh out documentation-wise

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

3 participants