From d20a07aa5e7f56188c680cc32fc88f01ad551e67 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Thu, 30 Apr 2020 13:58:25 +0200 Subject: Add Flake8 notes --- .flake8 | 2 ++ README.md | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .flake8 diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..e44b810 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore = E501 diff --git a/README.md b/README.md index 7352fa5..47c38df 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,26 @@ Dependencies ``` sudo apt install python3-numpy python3-scipy python3-sklearn ``` + +Code Style +--- + +Please do not commit code with significant PEP8 violations. It's best to check +this with a pre-commit hook: + +``` +#!/bin/sh + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=4b825dc642cb6eb9a060e54bf8d69288fbee4904 +fi + +# Redirect output to stderr. +exec 1>&2 + +git diff --cached $against | flake8 --diff +``` -- cgit v1.2.3