How do you refer to an iterator in docs?
Chris Angelico
rosuav at gmail.com
Fri Apr 20 22:29:57 EDT 2012
On Sat, Apr 21, 2012 at 9:40 AM, Terry Reedy <tjreedy at udel.edu> wrote:
> On 4/20/2012 9:41 AM, Roy Smith wrote:
>
>> Except that "list of foos" and "sequence of foos" make sense from a
>> grammar standpoint, but "iterator of foos" does not. Or maybe it does?
>
> I consider it grammatical, but idiomatically, it *is* an innovation.
> Language evolves as needs evolve.
It's grammatical and it covers the need. Function documentation always
involves domain-specific jargon, trying to write in "pure English" is
doomed to failure. Remember, you're writing docstrings for the benefit
of Python programmers using your code, not end users using your
application.
ChrisA
More information about the Python-list
mailing list