jupyter / jupyter/notebook

How Can I FInd the Usages of Different Jupyter Extension Developing APIs

Open
#5,237 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
13.3k
Forks
5.8k
Avg merge
6d 11h
Merged PRs (30d)
7

Description

I am now a new developer of jupyter notebook extensions. When I look at the codes of other extensions, I was really confused about the all kinds of APIs like "Jupyter.keyboard_manager.command_shortcuts.add_shortcuts", "cell.element.find()", etc. I tried to search the docs about these APIs but find nothing. If I don's understand the usage of this, it's hard for me to create a new extension. So I am just wondering how can I know the usages?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the extension API examples named in the issue, including Jupyter.keyboard_manager.command_shortcuts.add_shortcuts and cell.element.find(). Identify where these APIs are currently documented or defined, then document their usage and examples so extension developers can find the relevant guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.