Fix doc failure in CI on master #4020
Merged
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
Darksonn
added
T-docs
Merged
taiki-e
approved these changes
Aug 3, 2021
Merged
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.
I merged #3213 and CI on master broke. This PR fixes that by not generating the module when generating documentation if Tokio is not the crate being documented.
Note that the problem fixed by this also existed in released versions of Tokio — we just didn't run into it before now. For example,
trust-dns-protohad a failed documentation build on docs.rs because they tried to enable thedocsrsflag for dependencies when building documentation, but since Tokio was a dependency, and not the crate being documented, that resulted in Tokio failing to compile for the same reasons as why CI on master broke for us.