A monorepo containing jupyter-blocks and jupyter-tidyblocks. Blockly extension for JupyterLab.
Merge pull request #76 from afshin/update-docstrings
Update `IBlocklyRegistry` docstrings
authored by
Carlos Herrero
and committed by
GitHub
1ee7c2b0
01209517
+22
-30
+12
-15
packages/blockly/src/registry.ts
+12
-15
packages/blockly/src/registry.ts
···
51
51
/**
52
52
* Register a toolbox for the editor.
53
53
*
54
-
* @argument name Name of the toolbox.
54
+
* @argument name The name of the toolbox.
55
55
*
56
-
* @argument value Toolbox to register.
56
+
* @argument toolbox The toolbox to register.
57
57
*/
58
-
registerToolbox(name: string, value: ToolboxDefinition): void {
59
-
this._toolboxes.set(name, value);
58
+
registerToolbox(name: string, toolbox: ToolboxDefinition): void {
59
+
this._toolboxes.set(name, toolbox);
60
60
}
61
61
62
62
/**
63
-
* Register new blocks.
63
+
* Register block definitions.
64
64
*
65
-
* @argument blocks Blocks to register.
65
+
* @argument blocks A list of block definitions to register.
66
66
*/
67
67
registerBlocks(blocks: BlockDefinition[]): void {
68
68
Blockly.defineBlocksWithJsonArray(blocks);
69
69
}
70
70
71
71
/**
72
-
* Register new generators.
72
+
* Register a language generator.
73
73
*
74
-
* @argument name Name of the generator.
74
+
* @argument language The language output by the generator.
75
75
*
76
-
* @argument generator Generator to register.
76
+
* @argument generator The generator to register.
77
77
*
78
78
* #### Notes
79
-
* When registering a generator, the name should correspond to the language
80
-
* used by a kernel.
81
-
*
82
-
* If you register a generator for an existing language this will be overwritten.
79
+
* If a generator already exists for the given language it is overwritten.
83
80
*/
84
-
registerGenerator(name: string, generator: Blockly.Generator): void {
85
-
this._generators.set(name, generator);
81
+
registerGenerator(language: string, generator: Blockly.Generator): void {
82
+
this._generators.set(language, generator);
86
83
}
87
84
88
85
setlanguage(language: string): void {
+10
-15
packages/blockly/src/token.ts
+10
-15
packages/blockly/src/token.ts
···
21
21
/**
22
22
* Register a toolbox for the editor.
23
23
*
24
-
* @argument name Name of the toolbox.
24
+
* @argument name The name of the toolbox.
25
25
*
26
-
* @argument value Toolbox to register.
26
+
* @argument toolbox The toolbox to register.
27
27
*/
28
-
registerToolbox(name: string, value: ToolboxDefinition): void;
28
+
registerToolbox(name: string, toobox: ToolboxDefinition): void;
29
29
30
30
/**
31
-
* Register new blocks.
32
-
*
33
-
* @argument name Name of the toolbox.
31
+
* Register block definitions.
34
32
*
35
-
* @argument value Toolbox to register.
33
+
* @argument blocks A list of block definitions to register.
36
34
*/
37
35
registerBlocks(blocks: BlockDefinition[]): void;
38
36
39
37
/**
40
-
* Register new generators.
38
+
* Register a language generator.
41
39
*
42
-
* @argument name Name of the toolbox.
40
+
* @argument language The language output by the generator.
43
41
*
44
-
* @argument value Toolbox to register.
42
+
* @argument generator The generator to register.
45
43
*
46
44
* #### Notes
47
-
* When registering a generator, the name should correspond to the language
48
-
* used by a kernel.
49
-
*
50
-
* If you register a generator for an existing language this will be overwritten.
45
+
* If a generator already exists for the given language it is overwritten.
51
46
*/
52
-
registerGenerator(name: string, generator: Blockly.Generator): void;
47
+
registerGenerator(language: string, generator: Blockly.Generator): void;
53
48
}