[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Changes by Raymond Hettinger :


--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed
versions: +Python 3.7 -Python 2.7, Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Raymond Hettinger added the comment:


New changeset e2a30cd35b95dad55aea10347655f246348d1951 by Raymond Hettinger 
(Miss Islington (bot)) in branch '3.6':
[3.6] bpo-27385: Clarify docstring for groupby() (GH-3738) (#3744)
https://github.com/python/cpython/commit/e2a30cd35b95dad55aea10347655f246348d1951


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Roundup Robot]

Changes by Roundup Robot :


--
pull_requests: +3731

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Raymond Hettinger added the comment:


New changeset 49392c63a243052c8013bef80d35202bb6d7c404 by Raymond Hettinger in 
branch 'master':
bpo-27385: Clarify docstring for groupby() (#3738)
https://github.com/python/cpython/commit/49392c63a243052c8013bef80d35202bb6d7c404


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Changes by Raymond Hettinger :


--
pull_requests: +3724

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Changes by Raymond Hettinger :


Added file: http://bugs.python.org/file43571/groupbydoc.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Raymond Hettinger added the comment:

That's okay.  I'm taking care of both in this issue.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[R. David Murray]

R. David Murray added the comment:

Please open a separate issue for that problem.

--
nosy: +r.david.murray

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Josh Rosenberg]

Josh Rosenberg added the comment:

While you're fixing, the docstring should say "groupby(iterable, key=None)", 
not "groupby(iterable[, keyfunc])"; the functions accepts the key function by 
name, and the name is key, not keyfunc. And it can be passed explicitly as None 
(equivalent to not passing it at all), so the [, keyfunc] approach that 
indicates it's positional only and can't be explicitly passed as a default is 
wrong. Gets a little confusing because it also returns a "key", but the 
argument is definitely named "key", so we can't go calling it "keyfunc".

Mind you, seems like this could also be fixed by just Clinic-ifying it.

--
nosy: +josh.r

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Raymond Hettinger]

Raymond Hettinger added the comment:

The patch is fine.

--
assignee: docs@python -> rhettinger
priority: normal -> low

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Ned Deily]

Changes by Ned Deily :


--
nosy: +rhettinger
stage:  -> patch review
versions:  -Python 3.2, Python 3.3, Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27385] itertools.groupby has misleading doc string

[Grant Mathews]

New submission from Grant Mathews:

The itertools.groupby function is generally well-documented, but the fact that 
it only groups consecutive occurrences of keys is not mentioned in the doc 
string, which is where that information is most needed.

--
assignee: docs@python
components: Documentation
files: groupby_doc.patch
keywords: patch
messages: 269211
nosy: docs@python, gmathews
priority: normal
severity: normal
status: open
title: itertools.groupby has misleading doc string
versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6
Added file: http://bugs.python.org/file43531/groupby_doc.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com