Skip to content

Commit 4072e19

Browse files
committed
Clarify internal heartbeat conversion
1 parent ea01174 commit 4072e19

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

Mathlib/Util/SleepHeartbeats.lean

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ def sleepAtLeastHeartbeats (n : Nat) : IO Unit := do
3030
elab "sleep_heartbeats " n:num : tactic => do
3131
match Syntax.isNatLit? n with
3232
| none => throwIllFormedSyntax
33-
/- as this is a user facing command we multiply the user input by 1000 to match the maxHeartbeats
34-
option -/
33+
/-
34+
We multiply by `1000` to convert the user-facing heartbeat count to the
35+
internal heartbeat counter used by `IO.getNumHeartbeats`.
36+
-/
3537
| some m => sleepAtLeastHeartbeats (m * 1000)
3638

3739
example : 1 = 1 := by

0 commit comments

Comments
 (0)