Run doctests #69
Open
Run doctests #69
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the julia snippets in the tutorial are not actually run during the tests, despite the "doctests" section in the github workflow. This is because the tutorial is not marked as a "jldoctest". This has lead to the tutorial becoming out of date without noticing it. This PR introduces running the tutorial doctest section during testing, which will prevent the tutorial going out of date in the future.
Notably, to do this we need to install
Documenterinto the test environment. We do this by setting up a newProject.tomlfor the tests whereMLFlowClientis added as a local dependency.Note that as the tutorial is currently out of date, most like the CI for this PR will (and should!) fail until #65 #66 #67 #68 are merged and this branch is rebased.