Merge branch 'main' into show-reporters-command

FlexMeasures · May 18, 2023 · 6991de4 · 6991de4
2 parents 213e24e + 4b963f5
commit 6991de4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/.vscode/spellright.dict b/.vscode/spellright.dict
@@ -246,8 +246,8 @@ deserializing
 kwargs
 fsdomain
 filepath
+spellright
 Changelog
 Bugfixes
 Dockerfile
-―
 nt
diff --git a/documentation/dev/introduction.rst b/documentation/dev/introduction.rst
@@ -1,6 +1,7 @@
 .. _developing:
 
 
+
 Developing for FlexMeasures
 ===========================
 
@@ -36,8 +37,6 @@ Clone the `FlexMeasures repository <https://github.com/FlexMeasures/flexmeasures
 
    $ git clone https://github.com/FlexMeasures/flexmeasures.git
 
-.. note:: Are you using Visual Studio Code? Then the code you just cloned also contains the editor configuration (part of) our team is using!
-
 
 Dependencies
 ^^^^^^^^^^^^^^^^^^^^
@@ -211,6 +210,23 @@ If ``flake8``, ``black`` or ``mypy`` propose changes to any file, the commit is
 The changes proposed by ``black`` are implemented automatically (you can review them with `git diff`). Some of them might even resolve the ``flake8`` warnings :)
 
 
+Using Visual Studio, including spell checking
+----------------------------------------------
+
+Are you using Visual Studio Code? Then the code you just cloned also contains the editor configuration (part of) our team is using (see `.vscode`)!
+
+We recommend installing the flake8 and spellright extensions.
+
+For spellright, the FlexMeasures repository contains the project dictionary. Here are steps to link main dictionaries, which usually work on a Linux system:
+
+.. code-block:: bash
+
+   $ mkdir $HOME/.config/Code/Dictionaries
+   $ ln -s /usr/share/hunspell/* ~/.config/Code/Dictionaries
+
+Consult the extension's Readme for other systems.
+
+
 
 A hint about using notebooks
 ---------------