Add comment description of RetryingPeriodicExecutor

8e86593b9c64d8eafc1f7a257d24e5b007f98a9a

1 files changed, 13 insertions, 0 deletions

diff --git a/yt/yt/core/concurrency/retrying_periodic_executor.h b/yt/yt/core/concurrency/retrying_periodic_executor.h
index 6cb6d36a3e..a67d65feb2 100644
--- a/yt/yt/core/concurrency/retrying_periodic_executor.h
+++ b/yt/yt/core/concurrency/retrying_periodic_executor.h
@@ -66,10 +66,23 @@ private:
 
 ////////////////////////////////////////////////////////////////////////////////
 
+// Periodically executes callback which can fail using retries. Speciffics:
+// Fallible callback is modelled as TCallback<TError()>
+// Any non-Ok error is considered a failure.
+// Retries are made with exponential backoff see yt/yt/core/misc/backoff_strategy.h .
 class TRetryingPeriodicExecutor
     : public NDetail::TPeriodicExecutorBase<NDetail::TRetryingInvocationTimePolicy>
 {
 public:
+    //! Initializes an instance.
+    /*!
+     *  \note
+     *  We must call #Start to activate the instance.
+     *
+     *  \param invoker Invoker used for wrapping actions.
+     *  \param callback Callback<TError()> to invoke periodically.
+     *  \param options Period, splay, etc. and backoff options
+     */
     TRetryingPeriodicExecutor(
         IInvokerPtr invoker,
         TPeriodicCallback callback,