adambard/learnxinyminutes-docs

[python/en] 'yield' and itertools explanation missing

Open

#2969 opened on Oct 27, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (10,755 stars) (3,235 forks)batch import
help wanted

Description

the python version of "learn x in y minutes" was great. But it lacks the explanation for keywords like

"yield", "assert". Also it has no explanation for itertools, which is important.

I really enjoyed the format of learn x in Y min. and I wish it was complete & thorough

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Python knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding documentation for Python's 'yield' keyword and itertools module. Look at the existing Python file at 'python.html.markdown' in the repository to understand the current structure and style. Add a section explaining 'yield' (generators) and a separate section for itertools, including common functions like chain, cycle, and permutations. Ensure the explanation is beginner friendly with examples.