none
Documentation error in "while loop" RRS feed

  • General discussion

  • This is a great and needed project.  The documentation is written well does a pretty good job targeting the intended audience, but it does need to have some rework to eliminate jargon (most is relatively benign like 'hit' instead of 'press' a key, but there are still some more programming-centric things).

    I did catch one outright error though...  There is a typo the inverts the meaning in the documentation for "while loop".

    It says: "In the example below, we're halving a number until the result is greater than 1."

    It should say any of the following:

    1. "In the example below, we're halving a number until the result is less than or equal to 1."
    2. "In the example below, we're halving a number until the result is no longer greater than 1."
    3. "In the example below, we're halving a number as long as the previous result is greater than 1."

    Option 1 is clear but require the small leap the NOT > 1 is the same as <= 1.  Options 2 or 3 more closely match the language with the code.  I prefer option 2.

    Thanks,
    -Derek
    Friday, February 13, 2009 2:20 AM

All replies