test+doc: Doctests are now tested via rustdoc
#51
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.
rustdoc
will run the Rust doctests. Those latters userutie-test
which defines the
test_ruby!
macro. This macro runs the code of thedoctest inside the Ruby VM.
So for example, when one writes:
rustdoc
will generate in HTML a code block that only contains:but it will generate a test that will contain:
And this Ruby code (here,
true
), will be evaluated inside the RubyVM.
It's a very naive solution. The path to
rutie
is hardcoded forexample, and
RbConfig
is not found, so I had to hardcode itmyself. It's very likely to break in the future, but for the moment,
it works and it allows us to deliver a correct documentation with
correct examples to our users.