From f588686c427d86863605157571175c77025b6393 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Thu, 14 Apr 2022 10:33:41 +0000 Subject: [PATCH] deploy: 535a689cfcec896dd4ce74ef567bd30c11ade9e3 --- develop/code_style.html | 47 ++++++++++++---------------------------- develop/print.html | 47 ++++++++++++---------------------------- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- 4 files changed, 30 insertions(+), 68 deletions(-) diff --git a/develop/code_style.html b/develop/code_style.html index 0620f138e3..b63f45d140 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -151,49 +151,30 @@

The Synapse codebase uses a number of code formatting tools in order to quickly and automatically check for formatting (and sometimes logical) errors in code.

-

The necessary tools are detailed below.

-

First install them with:

+

The necessary tools are:

+ +

Install them with:

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

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 flake8 on -save as it takes a while and is very resource intensive.

+development workflow. It is not, however, recommended to run flake8 or mypy +on save as they take a while and can be very resource intensive.

General rules