Change #[cfg(docsrs)] to #[cfg(doc)] on use
#1504
Merged
Conversation
This file contains hidden or 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
|
Ah sweet, this is what I was looking for yesterday when doing rust-bitcoin/rust-miniscript#507 |
tcharding
previously approved these changes
Dec 23, 2022
apoelstra
previously approved these changes
Dec 31, 2022
|
Needs rebase. |
The additional `use` items were added to improve the style of documentation. Because they were only used for doc they were `cfg`ed. But because this is independent from being built by `docs.rs` the `cfg` should've been `doc` not `docsrs`. IOW `docsrs` means roughly `all(doc, nightly)` and the added items are unrelated to `nightly`.
95eef7f to
8d58ee2
Compare
apoelstra
approved these changes
Dec 31, 2022
apoelstra
added a commit
that referenced
this pull request
Feb 10, 2023
41f2dcf Improve test coverage for docs build (Tobin C. Harding) b4c14a4 hashes: Use automatic link (Tobin C. Harding) 96e8a08 ci: Remove redundant || exit (Tobin C. Harding) Pull request description: Currently the docs build commands in `hashes` and `bitcoin` differ, they should be the same. Add a command `cargo doc` to improve coverage e.g., recently we botched the feature guarding but since CI only runs `cargo rustdoc` with custom compiler conditional set we didn't catch it. Done after seeing: #1504 and CI should fail on this PR until 1504 is in. ACKs for top commit: apoelstra: ACK 41f2dcf Kixunil: ACK 41f2dcf Tree-SHA512: 7cde68292cfc6f32b75d066e188e7c418ee251f9a5abc57fbd642ba33e9cd5bd8ef7c5ba7cffd206acae6ddec2f8c3db38c8c911a4319e979158666b8225953d
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 chan
2F73
ges 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.
The additional
useitems were added to improve the style of documentation. Because they were only used for doc they werecfged. But because this is independent from being built bydocs.rsthecfgshould've beendocnotdocsrs.IOW
docsrsmeans roughlyall(doc, nightly)and the added items are unrelated tonightly.Do we want CI for this kind of thing? It feels a bit too much to me but if someone sends a PR I probably won't reject it.