diff --git a/develop/code_style.html b/develop/code_style.html index c352b63481..4f832a17cd 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -158,17 +158,13 @@ errors in code.

  • ruff, which can spot common errors; and
  • mypy, a type checker.
  • -

    Install them with:

    -
    pip install -e ".[lint,mypy]"
    -
    -

    The easiest way to run the lints is to invoke the linter script as follows.

    -
    scripts-dev/lint.sh
    -
    +

    See the contributing guide for instructions +on how to install the above tools and run the linters.

    It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run mypy -on save as they take a while and can be very resource intensive.

    +on save as it takes a while and can be very resource intensive.

    General rules

    -

    Install them with:

    -
    pip install -e ".[lint,mypy]"
    -
    -

    The easiest way to run the lints is to invoke the linter script as follows.

    -
    scripts-dev/lint.sh
    -
    +

    See the contributing guide for instructions +on how to install the above tools and run the linters.

    It's worth noting that modern IDEs and text editors can run these tools automatically on save. It may be worth looking into whether this functionality is supported in your editor for a more convenient development workflow. It is not, however, recommended to run mypy -on save as they take a while and can be very resource intensive.

    +on save as it takes a while and can be very resource intensive.

    General rules