Fix invalid/misleading syntax in example docs #11459
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docs make it look like it's valid daml to write
```haskell
Complete : ()
do
-- bind the ledger effective time to the tchoose variable using getTime
tchoose <- getTime
```
implying that binding a variable at the end of a do block is ok. This broadens the example to show the variable being used (it's possible that this was broken by a change to the snippets file)
This change now includes more context:
```Haskell
controller party can
-- A choice using a check on the current time
Complete : ()
do
-- bind the ledger effective time to the tchoose variable using getTime
tchoose <- getTime
-- assert that tchoose is no earlier than the begin time
assert (begin <= tchoose && tchoose < addRelTime begin period)
```
ghost
requested review from
cocreature
reviewed
Oct 29, 2021
| @@ -181,7 +181,7 @@ Here's an example of a choice that uses a check on the current time: | |||
|
|
|||
| .. literalinclude:: ../code-snippets/Snippets.daml | |||
| :language: daml | |||
| :lines: 42-46 | |||
| :lines: 40-48 | |||
There was a problem hiding this comment.
rather than switching around the line numbers which might get broken again by #11363 I’d recommend fixing this by switching over to :start-after: and :end-before and putting a marker in the snippet. That is much more robust against changes.
|
|
|
This has been resolved in the meantime, using @cocreature's suggestion of using references instead of line numbers. Current version can be seen here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The docs make it look like it's valid daml to write
implying that binding a variable at the end of a do block is ok. This broadens the example to show the variable being used (it's possible that this was broken by a change to the snippets file)
This change now includes more context:
controller party can -- A choice using a check on the current time Complete : () do -- bind the ledger effective time to the tchoose variable using getTime tchoose <- getTime -- assert that tchoose is no earlier than the begin time assert (begin <= tchoose && tchoose < addRelTime begin period)Pull Request Checklist
CHANGELOG_BEGINandCHANGELOG_ENDtagsNOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with
/AzurePipelines runtotrigger the build.