Anonymous avatar Anonymous committed 764e083

Updated setuptools integration doc

Comments (0)

Files changed (1)

docs/setuptools.rst

 Setuptools integration
 ======================
 
-Flake8 now depends on setuptools and its installation enables a command    
-that checks the Python files declared by your project.  To use it, add   
-flake8 to your setup_requires::
+Upon installation, Flake8 enables a setuptools command that checks Python 
+files declared by your project. 
+
+Running ``python setup.py flake8`` on the command line will check the files 
+listed in your ``py_modules`` and ``packages``.  If any warning is found, 
+the command will exit with an error code::
+
+    $ python setup.py flake8
+
+Also, to allow users to be able to use the command without having to install 
+flake8 themselves, add flake8 to the setup_requires of your setup() like so::
 
     setup(
         name="project",
         ]
     )
 
-Running ``python setup.py flake8`` on the command line will check the
-files listed in your ``py_modules`` and ``packages``.  If any warning
-is found, the command will exit with an error code::
 
-    $ python setup.py flake8
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.