Skip to content

Commit

Permalink
Linting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
enolfc committed Aug 29, 2024
1 parent a5c849a commit 17b84ec
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

[![Github Actions Status](https://github.com/EGI-Federation/notebooks-resource-warning/workflows/Build/badge.svg)](https://github.com/EGI-Federation/notebooks-resource-warning/actions/workflows/build.yml)

A JupyterLab extension that shows a notification whenever the usage of memory goes into `warn` status (as provided by the [Jupyter Resource Usage extension](https://github.com/jupyter-server/jupyter-resource-usage)
A JupyterLab extension that shows a notification whenever the usage of memory
goes into `warn` status (as provided by the
[Jupyter Resource Usage extension](https://github.com/jupyter-server/jupyter-resource-usage)

## Requirements

Expand Down Expand Up @@ -45,7 +47,9 @@ jupyter labextension develop . --overwrite
jlpm build
```

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
You can watch the source directory and run JupyterLab at the same time in
different terminals to watch for changes in the extension's source and
automatically rebuild the extension.

```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
Expand All @@ -54,9 +58,15 @@ jlpm watch
jupyter lab
```

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
With the watch command running, every saved change will immediately be built
locally and available in your running JupyterLab. Refresh JupyterLab to load the
change in your browser (you may need to wait several seconds for the extension
to be rebuilt).

By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
By default, the `jlpm build` command generates the source maps for this
extension to make it easier to debug using the browser dev tools. To also
generate source maps for the JupyterLab core extensions, you can run the
following command:

```bash
jupyter lab build --minimize=False
Expand All @@ -68,9 +78,11 @@ jupyter lab build --minimize=False
pip uninstall notebooks-resource-warning
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `resource_warning` within that folder.
In development mode, you will also need to remove the symlink created by
`jupyter labextension develop` command. To find its location, you can run
`jupyter labextension list` to figure out where the `labextensions` folder is
located. Then you can remove the symlink named `resource_warning` within that
folder.

### Packaging the extension

Expand Down

0 comments on commit 17b84ec

Please sign in to comment.