Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extendable with third-party plugins #20

Open
hoo761 opened this issue Jun 27, 2019 · 0 comments
Open

Extendable with third-party plugins #20

hoo761 opened this issue Jun 27, 2019 · 0 comments
Labels
type:Enhancement New feature or request
Milestone

Comments

@hoo761
Copy link
Contributor

hoo761 commented Jun 27, 2019

Jupyterlab supports a very wide varity of files and file viewers. Currently the API for commenting is usable for creating third party extensions, but the use is very limited and not very easy to integrate.

The press release mentions how comments can be on "anything". It also introduces the idea of a comment's "target". Simply put, the "target" of the comment is the thing which the comment is about. If you target a single line of code in your comment, it is because you want to address something about that line of code in your comment. The target is stored with the comment so that in the future you can see which things every comment targets.

As such, there are many kinds of "targets" (the press release enumerates several). It is reasonable to expect a heavy user of JupyterLab will have comments on many different targets -- possibly many hundred targets if they work with a team.

It would be ugly and distracting to show on the screen the target of every comment all at once. There will be too many. Thus, we must figure out a good UI/UX design to show only the targets which are most relevant for the user for their current context.

Everything about JupyterLab is extendable. It's a tenet on which JupyterLab software architecture is founded.

Thus, as we introduce the idea of a "target" for a comment, it should be such that other extensions can add new targets. For this, we need to design an API so that the targeting system is extendable.

@hoo761 hoo761 added this to the Second Release milestone Jun 27, 2019
@saulshanabrook saulshanabrook added the type:Enhancement New feature or request label Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants