Skip to content

Commit

Permalink
Fix pluggy entry points (documentation only) should be `ipylab_backen…
Browse files Browse the repository at this point in the history
…d` instead of `ipylab-python-backend'`.
  • Loading branch information
Alan Fleming committed Jun 8, 2024
1 parent d7d4c3d commit 8f61263
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions examples/autostart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"source": [
"# Autostart\n",
"\n",
"Autostart is a feature implemented using the [pluggy](https://pluggy.readthedocs.io/en/stable/index.html#pluggy) plugin system. The code associated with the entry point `ipylab-python-backend` will be called (imported) when `ipylab` is activated. `ipylab` will activate when Jupyterlab is started (provided `ipylab` is installed and enabled). \n",
"Autostart is a feature implemented using the [pluggy](https://pluggy.readthedocs.io/en/stable/index.html#pluggy) plugin system. The code associated with the entry point `ipylab_backend` will be called (imported) when `ipylab` is activated. `ipylab` will activate when Jupyterlab is started (provided `ipylab` is installed and enabled). \n",
"\n",
"There are no limitations to what can be done. But it is recommended to import on demand to minimise the time required to launch. Some possibilities include:\n",
"* Create and register custom commands;\n",
Expand All @@ -27,7 +27,7 @@
"Add the following in your `pyproject.toml`\n",
"\n",
"``` toml\n",
"[project.entry-points.ipylab-python-backend]\n",
"[project.entry-points.ipylab_backend]\n",
"myproject = \"myproject.pluginmodule\"\n",
"```\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion src/widgets/python_backend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class PythonBackendModel {
caption:
'Start the Ipylab Python backend that will run registered autostart plugins.\n ' +
' in "pyproject.toml" added entry for: \n' +
'[project.entry-points.ipylab-python-backend] \n' +
'[project.entry-points.ipylab_backend] \n' +
'\tmyproject = "myproject.pluginmodule"',

execute: () => IpylabModel.pythonBackend.checkStart()
Expand Down

0 comments on commit 8f61263

Please sign in to comment.