[python_by_example] While-loop description inverts the loop condition
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Open python_by_example.md and find the “While loops” section. Replace the inverted description so it says the block runs as long as the condition (i < ts_length) is true, then check the following sentence for consistent wording and review the rendered documentation.
Written by the indexing model from the issue text.
Description
In the "While loops" section, python_by_example.md currently reads:
A while loop will keep executing the code block delimited by indentation until the condition (
i < ts_length) is satisfied.
The logic is inverted: a while loop executes the block while the condition is true, and stops once it fails. As written, "until the condition is satisfied" describes a loop that runs while i < ts_length is false.
Suggested wording:
A while loop will keep executing the code block delimited by indentation as long as the condition (
i < ts_length) is true.
This matches the sentence that follows ("the program will keep adding values to the list until i equals ts_length"), which is stated correctly.
Found during native-editor review of the French edition — the machine translation had faithfully reproduced the inverted sentence, and the editor corrected it target-side in QuantEcon/lecture-python-programming.fr#25. Until it is corrected here, the French edition deliberately diverges from the source on this sentence. Same discovery path as #594.
- Dominant language
- JavaScript
- Stars
- 72
- Forks
- 31
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from QuantEcon/lecture-python-programming
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
QuantEcon/lecture-python-programming#607 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
QuantEcon/lecture-python-programming#622 · 4 comments ·
-
broken-links bug documentation
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
QuantEcon/lecture-python-programming#597 · 1 comment ·
All issues in QuantEcon/lecture-python-programming
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·
-
client-controller-update ta-bot-triage team-money-movement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
MetaMask/metamask-mobile#36594 ·