Show features (futures) in docs #151
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
faern
force-pushed
the
show-features-in-docs
branch
from
fb27d5a
to
462a805
Compare
taiki-e
approved these changes
Jul 5, 2020
|
It would be really nice to get this merged, but it looks like the PR is quite out of date. I'm going to update it myself. |
hawkw
added a commit
that referenced
this pull request
May 19, 2022
PR #151 added a CI job to try and build the documentation, failing on RustDoc errors. It turned out there was a handful of broken links, so that job is now failing. I meant to fix this as part of #151 but accidentally automerged it before fixing the docs, since automerge wasn't configured to require the docs build job to pass. Whoops. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
May 19, 2022
# 0.5.6 (May 19, 2022) ### Added - cell: add `UnsafeCell::into_inner` for parity with `std` (#272) - sync: re-enable `Arc::strong_count` (#172) - sync: implement `Arc::try_unwrap` (#262) - sync: add `mpsc::Receiver::try_recv` (#262) ### Documented - show feature flags in docs (#151) - fix broken RustDoc links (#273)
hawkw
added a commit
that referenced
this pull request
May 19, 2022
# 0.5.6 (May 19, 2022) ### Added - cell: add `UnsafeCell::into_inner` for parity with `std` (#272) - sync: re-enable `Arc::strong_count` (#172) - sync: implement `Arc::try_unwrap` (#262) - sync: add `mpsc::Receiver::try_recv` (#262) ### Documented - show feature flags in docs (#151) - fix broken RustDoc links (#273)
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.
The fact that there is a
futuresfeature flag and ablock_onmethod was a bit hard to discover. At least for me. That lead me to create #148. Turns out it was not needed.To make it more discoverable, this PR makes docs.rs build the documentation with all features active, so the extra functionality they enable are visible. It also uses the unstable
doc_cfgattribute to make it more obvious in the docs that those items are feature gated.This is taken more or less directly from how the tokio crate does the same thing.