From 34d2c73d99f19819cdf5859b8e7c9f2c2d22e500 Mon Sep 17 00:00:00 2001 From: Oleksii Karpenko Date: Mon, 8 Jul 2024 03:10:39 +0300 Subject: [PATCH] Update documentation --- README.md | 4 ++++ src/lib.rs | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97ab950..a2c547c 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,10 @@ async fn main() { Please visit [crate's documentation](https://docs.rs/kube-lease-manager/) to get more examples and usage details. +## TODO + +- [ ] Provide some real and useful examples. + ## Credits The author was inspired on this piece of work by two other crates that provide similar functionality: diff --git a/src/lib.rs b/src/lib.rs index 37d3817..10a5552 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -346,6 +346,7 @@ impl From for LeaseManagerError { /// /// This artificial example tries to run some workload as soon as it gets lease lock, /// and cancels workload if lock was lost. +/// /// Something similar is used in Kubernetes controllers that have several Pods running (to ensure high availability), /// but only one of them is eligible to make changes to the actual state. /// @@ -430,7 +431,7 @@ impl From for LeaseManagerError { /// /// ### Example /// -/// This example shows how to start actual work only after acquiring the lease lock and release lock after finish. +/// This example shows how to start actual work only after acquiring the lease lock and release it after finish. /// /// ```no_run /// use kube::Client;