Update potentially confusing sample_duration explanation - #3559
Open
ethancrawford wants to merge 1 commit into
Open
Update potentially confusing sample_duration explanation#3559ethancrawford wants to merge 1 commit into
ethancrawford wants to merge 1 commit into
Conversation
Given that recent changes have introduced live interactive code examples into the documentation, the code example in Tutorial 3.4 for printing out a sample_duration can be potentially confusing. If the user has their global tempo set to something other than the default 60 BPM and runs this interactive example, a different value is printed out in the log panel to the one revealed in the tutorial. To fix this, the tutorial now explains the output of this specific example in the context of the default 60 BPM tempo. Additionally, the explanation now talks about sample_duration's output being returned as BPM rather than seconds.
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
1 participant
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.
Given that recent changes have introduced live interactive code examples into the documentation, the code example in Tutorial 3.4 for printing out a sample_duration can be potentially confusing. If the user has their global tempo set to something other than the default 60 BPM and runs this interactive example, a different value is printed out in the log panel to the one revealed in the tutorial.
To fix this, the tutorial now explains the output of this specific example in the context of the default 60 BPM tempo.
Additionally, the explanation now talks about sample_duration's output being returned as BPM rather than seconds.