-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
allow running doctests with Revise #38258
Conversation
I don't think I'm the right person to review this. Maybe @fredrikekre? :) |
@Keno might be a good person to review since he added the revise-test functionality. |
Just bumping this again. Not really urgent, but I think this would be nice to have. |
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 like it!
Maybe it's just me, but I use "draft" to mean "something I am working on that isn't ready for review yet". So I never review anything marked "draft" unless specifically requested.
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.
This seems suuuuper helpful. I must confessed that I've given up on more than one doc change PR for Julia because the "modify - rebuild Julia - fix mistake - rebuild Julia - ... " cycle is sooo painful (I was trying to add more crossrefs and examples, and just figuring out how to get the crossrefs working drove me crazy and I gave up).
I can only speak for myself, but I think this PR would substantially boost my motivation to contribute tweaks to the Julia documentation, and hopefully it would do so for others, too.
I just started looking into this again, but doesn't seem like this works for Base yet and it also automatically rebuilds Julia every time changes are made to Base, so marking this as a draft again until I figure this out. |
bbffd84
to
03d1a79
Compare
Ok, I now tested this locally for Base and LinearAlgebra and everything seemed to work as expected. |
Co-authored-by: Max Horn <[email protected]>
03d1a79
to
cd90200
Compare
Co-authored-by: Max Horn <[email protected]> Co-authored-by: Max Horn <[email protected]>
Co-authored-by: Max Horn <[email protected]> Co-authored-by: Max Horn <[email protected]>
I think it would be quite useful to be able to run doctests using Revise as well. This worked for me locally, but please let me know if this should be implemented in a different way. Right now, I am creating a new environment in
doc/deps/revise
, in which Revise is installed and then I push that ontoLOAD_PATH
, but there might be a nicer way to do this.