AaltoSciComp / python-for-scicomp

Python for scientific computing course
https://aaltoscicomp.github.io/python-for-scicomp/
Other
25 stars 31 forks source link

content/productivity: Adding a chapter on productivity tools #269

Closed simo-tuomisto closed 1 year ago

simo-tuomisto commented 1 year ago

This PR adds a new chapter on productivity tools such as linters and code formatters.

simo-tuomisto commented 1 year ago

This is great!

One thing that can be useful in the context of Notebooks (where most of this course takes place), adding these dependencies adds you a button in notebooks to autoformat code:

jupyterlab-code-formatter
black
isort

Unfortunately jupyterlab-code-formatter does not seem to be available from defaults-channel. It is available from conda-forge as jupyterlab_code_formatter. Adding it as a pip package might be bit risky.

simo-tuomisto commented 1 year ago

I'll add mention of isort.

simo-tuomisto commented 1 year ago

I'll add mention of isort.

Added mentions of both tools.

bast commented 1 year ago

Approved. It's good to have this section as these are tools I now always rely on. They allow me to focus on code and not on "distractions" and easy fixes that a tool can do for me.