[2.7] bpo-33006 - Correct filter doc string to clarify 2nd argument can be iterable (GH-6015)

TonyFlury · miss-islington · commit 09ba83330b49 · 2019-05-28T18:36:04.000-07:00
https://bugs.python.org/issue33006
diff --git a/Misc/NEWS.d/next/Core and Builtins/2018-03-07-09-10-42.bpo-33006.Bzx3LA.rst b/Misc/NEWS.d/next/Core and Builtins/2018-03-07-09-10-42.bpo-33006.Bzx3LA.rst
@@ -0,0 +1,2 @@
+Clarified Doc string for builtin filter function. 2nd Argument can be any
+iterable. Patch by Tony Flury
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
@@ -351,11 +351,12 @@ builtin_filter(PyObject *self, PyObject *args)
 }
 
 PyDoc_STRVAR(filter_doc,
-"filter(function or None, sequence) -> list, tuple, or string\n"
-"\n"
-"Return those items of sequence for which function(item) is true.  If\n"
-"function is None, return the items that are true.  If sequence is a tuple\n"
-"or string, return the same type, else return a list.");
+"filter(function or None, iterable) -> list, string or tuple\n\
+\n\
+Return a sequence yielding those items of iterable for which function(item)\n\
+is true. If function is None, return the items that are true.\n\
+If iterable is a string or a tuple, the result also has that type; otherwise\n\
+it is always a list.");
 
 static PyObject *
 builtin_format(PyObject *self, PyObject *args)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Clarified Doc string for builtin filter function. 2nd Argument can be any`
	`2`	`+iterable. Patch by Tony Flury`