-
Notifications
You must be signed in to change notification settings - Fork 54
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
Improve documentation of callback functions #274
Improve documentation of callback functions #274
Conversation
I take that back, it does work, but the formatting is a bit unusual with the H1 or H2 in the sub bullet lists. |
Here is SciPy's solve_ivp docstring that also requires a callback function: That seems sufficient to me and still fits in with the numpydoc format. May I suggest that at least the "Parameters" and "Returns" headers in the sublist are turned into just bold |
That is a good suggestion, I was not entirely happy with the formatting either. I made the changes you suggested, please have a look. This may be some issue with my setup, but it seems to me that part of the list of attributes is cut off and not visible in the documentation for some reason (i.e., the |
If this callback is not provided, the Hessian is calculated numerically. | ||
|
||
|
||
**Parameters** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it somehow because of the multiple blank lines here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That fixed it for me. Remove one blank line above **Parameters**
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the line and pushed a commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, appreciate it.
This should fix #153 and hopefully generally improve readability of the documentation of the callbacks.