File 1024-timer-clarify-docs-for-apply_repeatedly-4.... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1024-timer-clarify-docs-for-apply_repeatedly-4.patch of Package erlang

From 63bc2c090d64bb0047195290d9d76617a83698fe Mon Sep 17 00:00:00 2001
From: Maria Scott <67057258+Maria-12648430@users.noreply.github.com>
Date: Wed, 14 Sep 2022 23:02:44 +0200
Subject: [PATCH 4/4] timer: clarify docs for apply_repeatedly/4

Adding a more elaborate explanation for what will happen if the execution time exceeds the interval.

Co-authored-by: Rickard Green <rickard@erlang.org>
---
 lib/stdlib/doc/src/timer.xml | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml
index 2e9144f4a2..2cbf7977a9 100644
--- a/lib/stdlib/doc/src/timer.xml
+++ b/lib/stdlib/doc/src/timer.xml
@@ -122,7 +122,15 @@
 finish before starting the next.
 If the execution time of the spawned process is greater than the
 given <c><anno>Time</anno></c>, the next process is spawned immediately
- after the one currently running has finished.
+ after the one currently running has finished. Assuming that execution
+ times of the spawned processes performing the applies on average
+ are smaller than <c><anno>Time</anno></c>, the amount of applies
+ made over a large amount of time will be the same even if some
+ individual execution times are larger than
+ <c><anno>Time</anno></c>. The system will try to catch up as soon
+ as possible. For example, if one apply takes
+ <c>2.5*<anno>Time</anno></c>, the following two applies will be
+ made immediately one after the other in sequence.
 Returns <c>{ok, <anno>TRef</anno>}</c> or
 <c>{error, <anno>Reason</anno>}</c>.
 </desc>
-- 
2.35.3

Places

File 1024-timer-clarify-docs-for-apply_repeatedly-4.patch of Package erlang

Places