Doctest fixes #18
Open
Doctest fixes #18
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
'cargo test --doc' would fail:
---- src/slab.rs - slab::ParseSlab (line 164) stdout ----
error[E0599]: no method named `add_unsafe_var` found for struct `ParseSlab` in the current scope
--> src/slab.rs:173:26
|
11 | unsafe { slab_mut.ps.add_unsafe_var("bad".to_string(), &bad); } // `add_unsafe_var()` only exists if the `un...
| ^^^^^^^^^^^^^^ method not found in `ParseSlab`
...
I checked that with the doc comment added, 'cargo test --doc' and
'cargo test --doc --features unsafe-vars' passes, the doc output looks unchanged,
and then when an error is introduced in the docs (e.g. a typo), they fail as
expected with '--features unsafe-vars'.
https://docs.rs/fasteval/0.2.4/fasteval/#methodology was garbled, and "cargo doc" was emitting a warning.
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.
No description provided.