summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-03-07 08:45:55 +0100
committerGitHub <noreply@github.com>2021-03-07 08:45:55 +0100
commit40a7f9e2f505ee3b97d720ea16835d14ba132434 (patch)
tree56b5a4b19256286e84e29166d144bc8bf419be92
parent95beb6f2aaf36d38ca1dc3abb7544fb878c45ca0 (diff)
parent6fb7373c87392d3babf5c8ed6abd1134526241d6 (diff)
Merge pull request #276 from matthiasbeyer/fix-doc-get
Add warning to Containers::get() method
-rw-r--r--src/lib.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index a9d9264..0e2fdd2 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -635,6 +635,11 @@ impl<'docker> Containers<'docker> {
}
/// Returns a reference to a set of operations available to a specific container instance
+ ///
+ /// # Warning
+ ///
+ /// This function does not check whether the container with `name` actually exists and returns
+ /// a potentially invalid handle.
pub fn get<S>(
&self,
name: S,