Improve renameVariable jsdoc (#3879)

This commit is contained in:
Beka Westberg
2020-05-03 11:15:51 -07:00
committed by GitHub
parent be50de6650
commit 498ca3cba1

View File

@@ -327,7 +327,9 @@ Blockly.Variables.createVariable =
Blockly.Variables.createVariableButtonHandler;
/**
* Rename a variable with the given workspace, variableType, and oldName.
* Opens a prompt that allows the user to enter a new name for a variable.
* Triggers a rename if the new name is valid. Or re-prompts if there is a
* collision.
* @param {!Blockly.Workspace} workspace The workspace on which to rename the
* variable.
* @param {Blockly.VariableModel} variable Variable to rename.