Skip to content

Commit

Permalink
Clarify documentation on setTime (#16607)
Browse files Browse the repository at this point in the history
See
https://discuss.daml.com/t/how-can-i-get-the-actual-time-when-running-scrips-on-visualstudio-code/6338/4,
we had a user that got confused about behavior in `daml test` so this
PR clarifies that.
  • Loading branch information
cocreature authored Mar 31, 2023
1 parent 182d8a8 commit dfc8619
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions daml-script/daml/Daml/Script.daml
Original file line number Diff line number Diff line change
Expand Up @@ -320,8 +320,8 @@ data SetTimePayload a = SetTimePayload

-- | Set the time via the time service.
--
-- This is only supported in static time mode when running over the gRPC API
-- and in Daml Studio.
-- This is only supported in Daml Studio and `daml test` as well as
-- when running over the gRPC API against a ledger in static time mode.
--
-- Note that the ledger time service does not support going backwards in time.
-- However, you can go back in time in Daml Studio.
Expand All @@ -333,8 +333,9 @@ setTime time = lift $ Free $ SetTime $ SetTimePayload with

-- | Advance ledger time by the given interval.
--
-- Only supported in static time mode when running over the gRPC API
-- and in Daml Studio. Note that this is not an atomic operation over the
-- This is only supported in Daml Studio and `daml test` as well as
-- when running over the gRPC API against a ledger in static time mode.
-- Note that this is not an atomic operation over the
-- gRPC API so no other clients should try to change time while this is
-- running.
--
Expand Down

0 comments on commit dfc8619

Please sign in to comment.