Skip to content

Commit

Permalink
docs(iroh-net): Document cfg(test) items as well (#2819)
Browse files Browse the repository at this point in the history
## Description

It seems the newer rust release enforces missing docs on this as well.


## Breaking Changes

None

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.
  • Loading branch information
flub authored Oct 21, 2024
1 parent 85bd8b7 commit a03a08e
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions iroh-net/src/relay/server/streams.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ pub enum MaybeTlsStream {
Plain(tokio::net::TcpStream),
/// A Tls wrapped [`tokio::net::TcpStream`]
Tls(tokio_rustls::server::TlsStream<tokio::net::TcpStream>),
/// An in-memory bidirectional pipe.
#[cfg(test)]
Test(tokio::io::DuplexStream),
}
Expand Down

0 comments on commit a03a08e

Please sign in to comment.