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

Docstrings and method signatures #28

Open
JonTong opened this issue Mar 17, 2021 · 0 comments
Open

Docstrings and method signatures #28

JonTong opened this issue Mar 17, 2021 · 0 comments

Comments

@JonTong
Copy link

JonTong commented Mar 17, 2021

When running in Jupyter or ipython, attempting to bring up the documentation for the iForest class produces only:

Init signature: iso.iForest(self, /, *args, **kwargs)
Docstring:      <no docstring>

While the example notebooks provide sufficient guidance on how to use the iForest class, it would be useful to have this available at the point of usage - both the full argument specification and the docstrings.

This might just be a question of setting the binding compile option of Cython to true (e.g. via decorators @cython.binding(True).

Happy to help out and create a PR if this would be desired/useful.

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

No branches or pull requests

1 participant