QuantEcon / QuantEcon/lecture-python-programming

[python_by_example] While-loop description inverts the loop condition

Open Beginner friendly
#599 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
72
Forks
31
Avg merge
2d 20h
Merged PRs (30d)
8

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.