Skip to content

Commit

Permalink
Docs: some betterments around VSCode and formatting.
Browse files Browse the repository at this point in the history
Point out that Rewrap is an option for line wrapping, once black does
not handle it all. Finally, cite a better option to handle multiple
Python venvs in that editor.
  • Loading branch information
glima committed Apr 8, 2021
1 parent 22a8dc7 commit 0fc28d2
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ Follow the [instal](install.md) steps to prepare the source code. Then follow th

### Visual Studio Code

First, click on the Python version at the bottom left and enter the path where the above command was issued. This will point the Code to the Poetry virtual environment.
First, click on the Python version at the bottom left of the editor's
window and enter the path where the above command was issued. This
will point the currenly workspace to use the correct Poetry virtual
environment.

Make sure below settings are in root level of `.vscode/settings.json`.

Expand Down Expand Up @@ -78,7 +81,14 @@ Then run `M-x add-dir-local-variable RET python-mode RET pyvenv-activate RET <pa
### Other setups

- Install and enable [ShellCheck](https://github.com/koalaman/shellcheck) to find bash errors locally.
- If you need to update the documentation, it is recommended to install the extension [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one). It helps to maintain the table of contents in the documentation.
- If there is need to update the documentation, it is recommended to
install the extension [Markdown All in
One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one).
It helps to maintain the table of contents in the documentation.
- While the black formatter does not handle long comments and the like
well (https://github.com/psf/black/issues/1331), you might want to
use the VSCode extension "Rewrap" manually, instead
(https://marketplace.visualstudio.com/items?itemName=stkb.rewrap).

## Code guideline

Expand Down

0 comments on commit 0fc28d2

Please sign in to comment.