summaryrefslogtreecommitdiff
path: root/flake8
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-02-25 09:06:45 -0600
committerIan Cordasco <graffatcolmingov@gmail.com>2016-02-25 09:06:50 -0600
commita4e984dbd258faf125a115bae1561db3fbd8e934 (patch)
tree29787fa01439fc1361d7d5bdca9edc5be1a7980c /flake8
parentcd18b9f175a3a73b03f58d4db7fd789c48c671bb (diff)
downloadflake8-a4e984dbd258faf125a115bae1561db3fbd8e934.tar.gz
Add and fix documentation
- Add more documentation around utils functions - Fix documentation about default formatting plugins - Add extra documentation of filenames_from predicate parameter - Add test for the default parameter of flake8.utils.fnmatch
Diffstat (limited to 'flake8')
-rw-r--r--flake8/utils.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/flake8/utils.py b/flake8/utils.py
index cd1cf72..7e08e41 100644
--- a/flake8/utils.py
+++ b/flake8/utils.py
@@ -106,7 +106,8 @@ def filenames_from(arg, predicate=None):
:param callable predicate:
Predicate to use to filter out filenames. If the predicate
returns ``True`` we will exclude the filename, otherwise we
- will yield it.
+ will yield it. By default, we include every filename
+ generated.
:returns:
Generator of paths
"""