Document pianoroll #784
Merged
Document pianoroll #784
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
felixroos
reviewed
Nov 5, 2023
packages/core/pianoroll.mjs
Outdated
| * @param {integer} cycles defaults to 4 - number of cycles to be displayed at the same time | ||
| * @param {number} playhead 0 to 1, defaults to 0.5 - location of the active notes on the time axis | ||
| * @param {integer} vertical 0 (default) or 1 - displays the roll vertically | ||
| * @param {boolean} labels false (default) or true - displays labels on individual notes (see the label function) |
There was a problem hiding this comment.
all booleans can either be 0 | 1 or false | true
There was a problem hiding this comment.
I guess we can document them all as boolean : 1/0 ?
|
@jarmitage would you like to review? |
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.
Add pianoroll, color and label function documentation for inline usage (reference tab or autocomplete)
Object key parameters were documented as classic parameters, for ease of formatting