Skip to content

Commit ece34ad

Browse files
ohrelyfcollonval
andauthored
'extension' to 'plugin' in README (#159)
* 'extension' to 'plugin' in README Match template changes from jupyterlab/extension-cookiecutter-ts#156 * Update src file * Fix new id Co-authored-by: Frédéric Collonval <[email protected]>
1 parent 8bc09d2 commit ece34ad

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

hello-world/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ of the `JupyterFrontEndPlugin` class:
130130
```ts
131131
// src/index.ts#L9-L12
132132

133-
const extension: JupyterFrontEndPlugin<void> = {
134-
id: 'hello-world',
133+
const plugin: JupyterFrontEndPlugin<void> = {
134+
id: 'hello-world:plugin',
135135
autoStart: true,
136136
activate: (app: JupyterFrontEnd) => {
137137
```
@@ -146,7 +146,7 @@ const extension: JupyterFrontEndPlugin<void> = {
146146
}
147147
};
148148

149-
export default extension;
149+
export default plugin;
150150
```
151151
<!-- prettier-ignore-end -->
152152

@@ -163,7 +163,7 @@ point into the extension. In this example, it calls the `console.log` function t
163163
something into the browser developer tools console.
164164

165165
Your new `JupyterFrontEndPlugin` instance has to be finally exported to be visible to
166-
JupyterLab, which is done with the line `export default extension`.
166+
JupyterLab, which is done with the line `export default plugin`.
167167

168168
Now that the extension code is ready, you need to install it within JupyterLab.
169169

hello-world/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ import {
66
/**
77
* Initialization data for the hello-world extension.
88
*/
9-
const extension: JupyterFrontEndPlugin<void> = {
10-
id: 'hello-world',
9+
const plugin: JupyterFrontEndPlugin<void> = {
10+
id: 'hello-world:plugin',
1111
autoStart: true,
1212
activate: (app: JupyterFrontEnd) => {
1313
console.log('the JupyterLab main application:', app);
1414
}
1515
};
1616

17-
export default extension;
17+
export default plugin;

0 commit comments

Comments
 (0)