Browse Source

Update extension_dev.rst

I just stumbled over that sentence while reading up on JupyterLab extensions. At first it sounds as if source extensions and prebuilt extensions were mutually exclusive types of extensions, but two paragraphs later it is clarified that the same source base of an extension can be used to publish of both "types" of extension at the same time. As the audience of this documentation is developers, it would be better to take the developer perspective, not the end-user perspective.
Bernhard Stadler 4 years ago
parent
commit
c20451ceca
1 changed files with 1 additions and 1 deletions
  1. 1 1
      docs/source/extension/extension_dev.rst

+ 1 - 1
docs/source/extension/extension_dev.rst

@@ -44,7 +44,7 @@ Here is some autogenerated API documentation for JupyterLab and Lumino packages:
 Overview of Extensions
 ----------------------
 
-A JupyterLab plugin is the basic unit of extensibility in JupyterLab. An extension is a package that contains one or more JupyterLab plugins. There are several types of extensions:
+A JupyterLab plugin is the basic unit of extensibility in JupyterLab. An extension is a package that contains one or more JupyterLab plugins. Extensions can be distributed in two ways:
 
 - A *source extension* is a JavaScript (npm) package that exports one or more plugins. Installing a source extension requires a user to rebuild JupyterLab. This rebuilding step requires Node.js and may take a lot of time and memory, so some users may not be able to install a source extension. However, the total size of the JupyterLab code delivered to a user's browser may be reduced compared to using prebuilt extensions. See :ref:`deduplication` for the technical reasons for rebuilding JupyterLab when a source extension is installed.
 - A *prebuilt extension* (new in JupyterLab 3.0) distributes a bundle of JavaScript code prebuilt from a source extension that can be loaded into JupyterLab without rebuilding JupyterLab. In this case, the extension developer uses tools provided by JupyterLab to compile a source extension into a JavaScript bundle that includes the non-JupyterLab JavaScript dependencies, then distributes the resulting bundle in, for example, a Python pip or conda package. Installing a prebuilt extensions does not require Node.js.