How do you refer to an iterator in docs?

Jacob MacDonald jaccarmac at gmail.com
Fri Apr 20 11:11:10 EDT 2012


On Friday, April 20, 2012 6:41:25 AM UTC-7, Roy Smith wrote:
> In article <4f910c3d$0$29965$c3e8da3$5496439d at news.astraweb.com>,
>  Steven D'Aprano <steve+comp.lang.python at pearwood.info> wrote:
> 
> > I refer you to your subject line:
> > 
> > "How do you refer to an iterator in docs?"
> > 
> > In documentation, I refer to an iterator as an iterator, just as I would 
> > refer to a list as a list, a dict as a dict, or a string as a string.
> 
> 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?

Unless you're writing the docstring for end users, I think you should be fine using Python words. After all, this is Python :)



More information about the Python-list mailing list