Document tls example with compilation instruction #896
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
It was clear that I didn't need the #[cfg(feature ...)] in order to get a Server that could respond to .tls(), but I wasn't immediately sure if just adding the tls feature to the warp dependency (in Cargo.toml) was enough, or I had to specify some transitive dependency with it, or something else. And as the feature wasn't enabled, the docs produced with `cargo doc --workspace` didn't include Server.tls, so I started to question if the example I was looking at even matched the warp version I was working with. Eventually I just tried adding it to the warp dep and it (of course) just worked, but for the sake of others I reckon a more explicit pointing in the right direction could be helpful.
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.
It was clear that I didn't need the
#[cfg(feature ...)]in order to geta
Serverthat could respond to.tls(), but I wasn't immediately sure ifjust adding the tls feature to the warp dependency (in Cargo.toml) was
enough, or I had to specify some transitive dependency with it, or
something else. And as the feature wasn't enabled, the docs produced
with
cargo doc --workspacedidn't includeServer.tls, so I started toquestion if the example I was looking at even matched the warp version
I was working with.
Eventually I just tried adding it to the warp dep and it (of course)
just worked, but for the sake of others I reckon a more explicit
pointing in the right direction could be helpful.