New submission from Steven Barker:

The documentation for the csv.writer.writerows method says that it expects "a 
list of row objects", when it really will accept any iterable that yields rows 
(such as a generator). While it's often nice for code to be more accepting than 
the documented requirements, I think the docs in this case should state that 
writerows() expects an iterable, rather than misinforming users that a list is 
required.

This documentation issue was brought up in a Stack Overflow question here: 
http://stackoverflow.com/questions/28636848/csv-writer-writerows-takes-iterator

I expect the necessary documentation patch will be pretty trivial, and if 
nobody else gets to it first, I will try to provide one when I have enough time 
to update my cpython checkout (not soon, alas).

----------
assignee: docs@python
components: Documentation
messages: 236328
nosy: Steven.Barker, docs@python
priority: normal
severity: normal
status: open
title: The writer.writerows method should be documented as accepting any 
iterable (not only a list)
type: enhancement
versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue23495>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to