Add new method and tidy examples #110
Conversation
pbrkr
force-pushed
the
add-new-method-and-tidy-docs
branch
2 times, most recently
from
6de9fda to
76ed47c
Compare
|
Looks like CI tests are failing due to rust-lang/rustup#4220. |
This allows simpler instantiation of a new Gpx object.
These changes simplify the example and allow it to be ran as a doctest. - Use ::new() functions instead of struct literals to make the code easier to read. - Use the tempfile crate so that we can write to a throw-away file. - Convert the example to a main() function with a simpler function signature. - Re-arrange statements so that we populate the Gpx object first then open the output file and write to it.
These changes allow the example to be ran as a doctest.
michaelkirk
force-pushed
the
add-new-method-and-tidy-docs
branch
from
76ed47c to
4343e29
Compare
michaelkirk
left a comment
michaelkirk
left a comment
There was a problem hiding this comment.
LGTM, I rebased and will merge as soon as tests pass. Thank you!
| pub mod errors; | ||
|
|
||
| // Ensure that examples in the README are tested | ||
| #[doc = include_str!("../README.md")] |
There was a problem hiding this comment.
I've never seen this before. Love it.
There was a problem hiding this comment.
I found an example in the docs: https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#include-items-only-when-collecting-doctests
Another possible use of #[cfg(doctest)] is to test doctests that are included in your README file without including it in your main documentation. For example, you could write this into your lib.rs to test your README as part of your doctests:
#[doc = include_str!("../README.md")] #[cfg(doctest)] pub struct ReadmeDoctests;This will include your README as documentation on the hidden struct ReadmeDoctests, which will then be tested alongside the rest of your doctests.
2 participants
CHANGELOG.mdif knowledge of this change could be valuable to users.