jupyterlab / jupyterlab/extension-examples

Add an example about Comms

Open
#191 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
516
Forks
187
PR merge metrics
No merged PRs in 30d

Description

### Problem

The classic notebook v6 documentation has a dedicated page about Comms: https://jupyter-notebook.readthedocs.io/en/v6.4.8/comms.html

They include JavaScript code snippets to define comm targets on the frontend.

But the JupyterLab documentation doesn't appear to have anything like this, using the `kernel.registerCommTarget()` API.

### Proposed Solution

A dedicated example would be great, and could be linked to from the Notebook v7 and JupyterLab docs.

Contributor guide

No contributing guide indexed for this repository

Research direction

Use the classic Notebook v6 comms page and the JupyterLab `kernel.registerCommTarget()` API as references. Add a dedicated JupyterLab Comms example and ensure it can be linked from the Notebook v7 and JupyterLab documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.