summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-06-11 13:01:24 +0200
committerMatthias Beyer <mail@beyermatthias.de>2021-06-11 13:01:24 +0200
commitb90433f7dca3a8f0f2c4736d3c0a329b3d622907 (patch)
treeab752bdbc5c9e402eba173105cba1e913f9c226f /src
parent4f92d5419f53156b224f247ad9a7812bc5f05b6e (diff)
Fix markup of doc comment
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'src')
-rw-r--r--src/container.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/container.rs b/src/container.rs
index 0f9229c..83b5475 100644
--- a/src/container.rs
+++ b/src/container.rs
@@ -114,11 +114,13 @@ impl<'docker> Container<'docker> {
.await
}
- /// Attaches a `[TtyMultiplexer]` to the container.
+ /// Attaches a [Multiplexer](crate::tty::Multiplexer) to the container.
///
- /// The `[TtyMultiplexer]` implements Stream for returning Stdout and Stderr chunks. It also implements `[AsyncWrite]` for writing to Stdin.
+ /// The [Multiplexer](crate::tty::Multiplexer) implements Stream for returning Stdout and
+ /// Stderr chunks. It also implements `[AsyncWrite]` for writing to Stdin.
///
- /// The multiplexer can be split into its read and write halves with the `[split](TtyMultiplexer::split)` method
+ /// The multiplexer can be split into its read and write halves with the
+ /// [split](crate::tty::Multiplexer::split) method
///
/// [Api Reference](https://docs.docker.com/engine/api/v1.41/#operation/ContainerAttach)
pub async fn attach(&self) -> Result<TtyMultiPlexer<'docker>> {