-
Notifications
You must be signed in to change notification settings - Fork 21
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
Add test harness #49
Merged
Add test harness #49
Conversation
This file contains 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
vks
reviewed
Feb 22, 2022
vks
reviewed
Feb 22, 2022
vks
reviewed
Feb 22, 2022
vks
reviewed
Feb 22, 2022
vks
approved these changes
Feb 22, 2022
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.
Looks great! I only have some minor questions and suggestions.
Co-authored-by: Vinzent Steinberg <Vinzent.Steinberg@gmail.com>
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.
Uses
doc_comment
to add a test harness for the code samples within documentation. This allows us to specify dependency versions (not possible through mdbook).Note that not all code samples actually run since this uses the playground, which currently uses an old version of
rand_pcg
.As for testing links... in theory
mdbook-linkcheck
does this, but using it on this repo generates a lot of errors like this:These links (e.g.
../rand/rand/seq/trait.IteratorRandom.html#method.choose_stable
) work where deployed (and locally with a symlink to the built docs). We could replace with absolute URLs, but I suspectlinkcheck
would ignore them in that case.... thus, I just laboriously clicked on every link to test.
Some documentation got updated here: the Sequences page, part of the Distributions page. @vks would be nice if you do a quick review.
Closes #46. Closes #2 (well, link checks are omitted — without a plan for handling cross-crate links I don't see much use for it).