docs: enable and clean up ignored doc tests #2896
Open
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
mladedav
requested review from
hawkw,
carllerche,
davidbarsky and
a team
as code owners
mladedav
force-pushed
the
dm/ignored-doc-test-master
branch
from
5459b7c
to
efee22a
Compare
kaffarell
reviewed
Mar 4, 2024
tracing/src/lib.rs
Outdated
| //! ```ignore | ||
| //! # // this doctest is ignored because we don't have a way to say | ||
| //! # // that it should only be run with cfg(feature = "attributes") | ||
| //! ``` |
There was a problem hiding this comment.
Please add ```rust here, so that we stay consistent :)
There was a problem hiding this comment.
Done. I've added it everywhere in this file, but for the record, there are still some places where it is not used. I originally decided against changing it explicitly everywhere so that there are not unnecessary changes.
Arguably the one you pointed to was already a change but I thought I'd just go with whatever was at the place.
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.
Motivation
Some tests were ignored with a TODO to enable them.
The doc-test for Subscriber::record provides misleading code that does not compile.
Solution
I enabled the tests that can be enabled.
I fixed the usage of omitted fields in Subscriber::record docs, but since the example uses a macro from tracing, it cannot be enabled.
For some tests I added a check that a feature that is needed is present. All tests should now work either out of the box or with
--all-features