fix: clarify numbering of steps for use in playAction#66
Open
jstarpl wants to merge 2 commits into
Open
Conversation
Collaborator
|
Looks good to me! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Currently the specification document is not very clear on how the steps are numbered. There is no specific information, but the diagrams and example text talks about step 1, step 2 and so on. All ograf template runtimes and servers known to me use 0-based step indexing, meaning the first step is can be displayed through
playAction({ goto: 0 }). This does make sense on many levels & is generally consistent with Computer Science best practices. This change makes this numbering scheme explicit and modifies the examples to reduce ambiguity.