Skip to content

Commit c6e56ba

Browse files
committed
Update installation
1 parent 46d3acd commit c6e56ba

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/installation.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ Option 2) With Conda
3333
.. important::
3434
You will also need to install a code formatter for this plugin to work. The default formatter for Python are :code:`isort` and :code:`black`, and :code:`formatR` for R. Installing these would be a good place to start.
3535

36+
There is a chance you will observe a warning message when running :code:`jupyter serverextension enable --py jupyterlab_code_formatter`, this should be safe to ignore for now (see this `issue`_).
37+
38+
Also for users that haven't upgraded JupyterLab to version 3.0.0+, you will also need to run :code:`jupyter labextension install @ryantam626/jupyterlab_code_formatter`.
39+
3640
Installation Step 2 (Installing a supported code formatter)
3741
-----------------------------------------------------------
3842

@@ -87,3 +91,4 @@ You might need to change the default formatter selection via configuration as sh
8791
.. _YAPF: https://github.com/google/yapf
8892
.. _formatR: https://github.com/yihui/formatR/
8993
.. _styler: https://github.com/r-lib/styler
94+
.. _issue: https://github.com/ryantam626/jupyterlab_code_formatter/issues/182

0 commit comments

Comments
 (0)