-
Notifications
You must be signed in to change notification settings - Fork 69
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
Turn code samples into doctests on first page of docs #1187
Conversation
Also I wasn't able to build the documentation locally (see #1189), so if you have any tips I'll gladly take them |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #1187 +/- ##
==========================================
+ Coverage 75.39% 75.61% +0.21%
==========================================
Files 35 35
Lines 9788 9891 +103
==========================================
+ Hits 7380 7479 +99
- Misses 2408 2412 +4 ☔ View full report in Codecov by Sentry. |
This is good to go |
Fix #1188
In the section on caveats, the code samples are not run when the documentation is built, which means they can get outdated.
I realized that because I tried the first one (on temporary storage and it threw an error).
This PR:
Reverse
as the first argument toautodiff
)