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

[Doc] Document the callback signature better in docs #823

Closed
eddiebergman opened this issue Feb 23, 2022 · 3 comments · Fixed by #875
Closed

[Doc] Document the callback signature better in docs #823

eddiebergman opened this issue Feb 23, 2022 · 3 comments · Fixed by #875
Labels
documentation Documentation is needed/added.

Comments

@eddiebergman
Copy link
Contributor

eddiebergman commented Feb 23, 2022

Code:

Docs:

There is no example and the only way to know about the signature required is to look into the code.

@renesass I assume Sphinx is hiding dunder methods? Is there a way to remove this for a specific module?

Edit: Better solution is probably just add the documentation to the class docstring

@eddiebergman eddiebergman added the documentation Documentation is needed/added. label Feb 23, 2022
@stale
Copy link

stale bot commented Jun 17, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jun 17, 2022
@renesass renesass removed the stale label Jun 23, 2022
@eddiebergman eddiebergman reopened this Aug 12, 2022
@eddiebergman
Copy link
Contributor Author

This needs an example or something more prominent, I don't think there's enough around for a user to figure out how to do early stopping at the moment, as needed in #877

@renesass
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation is needed/added.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants