Merge pull request #9 from bsmoliak/master

Enable Flake8 user and project configuration
mattijn · Jan 8, 2019 · 3f9d9b2 · 3f9d9b2
2 parents a313cc9 + 6f1bc61
commit 3f9d9b2
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 1,046 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 *.pyc
 *.tar.gz
+
+# Jupyter Notebook
+.ipynb_checkpoints
diff --git a/.ipynb_checkpoints/README-checkpoint.md b/.ipynb_checkpoints/README-checkpoint.md
diff --git a/.ipynb_checkpoints/pycodestyle_magic-checkpoint.py b/.ipynb_checkpoints/pycodestyle_magic-checkpoint.py
diff --git a/README.md b/README.md
@@ -8,6 +8,20 @@ Make sure you've the Python package `pycodestyle`, `flake8` and this `pycodestyl
 pip install flake8 pycodestyle pycodestyle_magic
 ```
 
+# configuration
+
+Flake8 and pycodestyle will discover and manage user configuration files
+(stored in a user's home directory or in the XDG directory inside their home
+directory) or project configuration files (stored in the current directory).
+See their respective docs for specific details on configuration file naming,
+syntax, and location.
+
+Additionally, Flake8 cell magic ignores four codes by default:
+  * W292 - *no newline at end of file*; not relevant in an iPython cell
+  * W391 - *blank line at end of file*; not relevant in an iPython cell
+  * F401 - *module imported but unused*; a module may be imported in one cell and used in another
+  * F821 - *undefined name name*; a variable may be defined in one cell and used in another
+
 # usage
 Enable the magic function by using the pycodestyle_magic module in a cell
 
@@ -30,4 +44,3 @@ See notebooks in notebook directory for example use cases, as such:
 
 Examples notebooks were slightly adapted from
 https://github.com/SiggyF/notebooks/blob/master/styleguide.ipynb
-