docs: annotate io mod with doc_cfg #1808
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
Annotates types in `tokio::io` module with their required feature flag. This annotation is included in generated documentation. Notes: * The annotation must be on the type or function itself. Annotating just the re-export is not sufficient. * The annotation must be **inside** the `pin_project!` macro or it is lost.
|
Once we land on specifics for style, it can be applied to the rest of the crate. |
LucioFranco
approved these changes
Nov 22, 2019
taiki-e
reviewed
Nov 22, 2019
taiki-e
reviewed
Nov 22, 2019
|
Perhaps we need to update CI config. tokio/ci/azure-deploy-docs.yml Line 18 in 8546ff8 Line 77 in 8546ff8 |
taiki-e
reviewed
Nov 22, 2019
tokio/src/io/util/read_to_end.rs
Outdated
| cfg_io_util! { | ||
| #[derive(Debug)] | ||
| #[must_use = "futures do nothing unless you `.await` or poll them"] | ||
| pub struct ReadToEnd<'a, R: ?Sized> { |
There was a problem hiding this comment.
As ReadToEnd is used internally even when io-util feature is disabled, it seems to be necessary to use an attribute.
There was a problem hiding this comment.
ReadToEnd is only *publicly available w/ the feature. I do need to fix it though.
Co-Authored-By: Taiki Endo <[email protected]>
Co-Authored-By: Taiki Endo <[email protected]>
33 tasks
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.
Annotates types in
tokio::iomodule with their required feature flag.This annotation is included in generated documentation.
Notes:
The annotation must be on the type or function itself. Annotating just
the re-export is not sufficient.
The annotation must be inside the
pin_project!macro or it islost.