-
Notifications
You must be signed in to change notification settings - Fork 4
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
Use @autodocs
to dynamically include all docstrings
#123
Conversation
What about the specializations? Currently, they are not included in the API list in the docs. I would suggest to add a new subsection |
Benchmark Results
Benchmark PlotsA plot of the benchmark results have been uploaded as an artifact to the workflow run for this PR. |
I just did that. What do you think, @mikeingold? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #123 +/- ##
=======================================
Coverage 95.75% 95.75%
=======================================
Files 17 17
Lines 259 259
=======================================
Hits 248 248
Misses 11 11 ☔ View full report in Codecov by Sentry. |
LGTM! Nice work. Makes progress on #62 |
@autodocs
we don't need to manually list all definitions with docstring. This means that, e.g., in Use a new DifferentiationMethod type for specifying derivative methods #122 we don't need to change the docs, but the new docstrings are found automatically.BezierCurve
because otherwise they would appear three times, which would be redundant,