Skip to content

Commit

Permalink
Update TS API links
Browse files Browse the repository at this point in the history
  • Loading branch information
fcollonval committed Jan 15, 2021
1 parent 5696a98 commit 7f89e5d
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions advanced/kernel-messaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ execution result.
## Initializing and managing a Kernel Session (`panel.ts`)

Jupyterlab provides a class `SessionContext`
([see the documentation](https://jupyterlab.github.io/jupyterlab/apputils/classes/sessioncontext.html))
([see the documentation](https://jupyterlab.github.io/jupyterlab/classes/_apputils_src_index_.sessioncontext.html))
that manages a single kernel session. Here is the code to initialize such session:

```ts
Expand Down Expand Up @@ -76,7 +76,7 @@ const manager = app.serviceManager;
With these lines, you can extend the panel widget from the [signal example](../../basics/signals) to initialize a
kernel. In addition, you will create a `KernelModel` class in it and
overwrite the `dispose` and `onCloseRequest` methods of the `StackedPanel`
([see the documentation](https://jupyterlab.github.io/lumino/api/widgets/classes/stackedpanel.html))
([see the documentation](https://jupyterlab.github.io/lumino/widgets/classes/stackedpanel.html))
to free the kernel session resources if the panel is closed. The whole adapted
panel class looks like this:

Expand Down
4 changes: 2 additions & 2 deletions advanced/kernel-output/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ followed by the creation of the visual element.
## Initializing a Kernel Session

To interact with a kernel, you can create a `SessionContext`
object ([see the documentation](https://jupyterlab.github.io/jupyterlab/apputils/classes/sessioncontext.html)).
object ([see the documentation](https://jupyterlab.github.io/jupyterlab/classes/_apputils_src_index_.sessioncontext.html)).
Here it is stored in the private `_sessionContext` variable:

```ts
Expand Down Expand Up @@ -134,7 +134,7 @@ this._outputarea = new SimplifiedOutputArea({
```

`SimplifiedOutputArea` provides a static method `execute` that sends
some code to a kernel through a `ISessionContext` ([see documentation](https://jupyterlab.github.io/jupyterlab/outputarea/classes/simplifiedoutputarea.html#execute)). And then it displays the result
some code to a kernel through a `ISessionContext` ([see documentation](https://jupyterlab.github.io/jupyterlab/classes/_outputarea_src_index_.simplifiedoutputarea.html#execute)). And then it displays the result
in the specific `SimplifiedOutputArea` object you created:

```ts
Expand Down
2 changes: 1 addition & 1 deletion basics/datagrid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
JupyterLab is built on top of [Lumino](https://github.com/jupyterlab/lumino).
That library defines `Widget` as the primary interface brick.

In this example [the datagrid lumino example](https://jupyterlab.github.io/lumino/datagrid/index.html)
In this example [the datagrid lumino example](https://jupyterlab.github.io/lumino/datagrid/classes/datagrid.html)
is integrated into JupyterLab.

First you need to import `StackedPanel`, `DataGrid`
Expand Down
2 changes: 1 addition & 1 deletion basics/signals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In this extension, a simple button will be added to print something to the conso

JupyterLab's Lumino engine uses the `ISignal` interface and the
`Signal` class that implements this interface for communication
(read more on the [documentation](https://jupyterlab.github.io/lumino/api/signaling/globals.html) page).
(read more on the [documentation](https://jupyterlab.github.io/lumino/signaling/index.html) page).

The basic concept is as follows:

Expand Down
2 changes: 1 addition & 1 deletion command-palette/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ const extension: JupyterFrontEndPlugin<void> = {
```
The `ICommandPalette`
([documentation](https://JupyterLab.github.io/JupyterLab/interfaces/_apputils_src_commandpalette_.icommandpalette.html))
([documentation](https://jupyterlab.github.io/jupyterlab/interfaces/_apputils_src_index_.icommandpalette.html))
is passed to the `activate` function as an argument (variable `palette`) in
addition to the JupyterLab application (variable `app`).
Expand Down
4 changes: 2 additions & 2 deletions commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ It is quite common for extension to define one or more such a command.

In this extension, you are going to add a command to the application command registry.

The registry has `CommandRegistry` type ([documentation](https://jupyterlab.github.io/lumino/api/commands/classes/commandregistry.html)).
The registry has `CommandRegistry` type ([documentation](https://jupyterlab.github.io/lumino/commands/classes/commandregistry.html)).

To see how you can access the application command registry, open the file `src/index.ts`.

Expand Down Expand Up @@ -58,7 +58,7 @@ The CommandRegistry is an attribute of the main JupyterLab application
adds your own function.

That method takes two arguments: the unique command id
and [options](https://jupyterlab.github.io/lumino/api/commands/interfaces/commandregistry.icommandoptions.html) for the command.
and [options](https://jupyterlab.github.io/lumino/commands/interfaces/commandregistry.icommandoptions.html) for the command.

The only mandatory option is `execute`, this takes the function to be called
when the command is executed. It can optionally takes arguments (arbitrarily defined
Expand Down
2 changes: 1 addition & 1 deletion settings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ in a JupyterLab extension.
![settings example](preview.gif)

The core token required for handling the settings is
`ISettingRegistry` ([documentation](https://jupyterlab.github.io/jupyterlab/settingregistry/modules/isettingregistry.html)). To use it,
`ISettingRegistry` ([documentation](https://jupyterlab.github.io/jupyterlab/modules/_settingregistry_src_index_.isettingregistry.html)). To use it,
you first need to install its npm package:

```bash
Expand Down
2 changes: 1 addition & 1 deletion state/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ in a JupyterLab extension.
![state example](preview.gif)

The core token required for handling the state database (DB) is
`IStateDB` ([documentation](https://jupyterlab.github.io/jupyterlab/statedb/interfaces/istatedb.html)).
`IStateDB` ([documentation](https://jupyterlab.github.io/jupyterlab/interfaces/_statedb_src_index_.istatedb.html)).

To use it, you first need to install its npm package:

Expand Down

0 comments on commit 7f89e5d

Please sign in to comment.