Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added itertoolz getter documentation #420

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

MatanCohe
Copy link

No description provided.

@@ -797,6 +797,32 @@ def pluck(ind, seqs, default=no_default):


def getter(index):
"""
Return a callable object that fetch item from its operand using the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit: as per PEP 257, I would prefer that the docstring begin with a short description that fits on a single line followed by a blank line. Perhaps something short and friendly, such as:
""" Return callable that gets elements in a sequence or dict

@eriknw
Copy link
Member

eriknw commented Nov 13, 2018

Cool, thanks. Maybe add a See Also section that includes pluck and get. Actually, it may be worth explaining that getter(ind)(seq) is equivalent to get(ind, seq).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants