[docs] [issue16607] Bad examples in documentation

John Hampton report at bugs.python.org
Thu Dec 13 17:53:58 CET 2012


John Hampton added the comment:

Ok, but perhaps in order to aviod confusion the documentation could be changed so that the examples are complete or have an additional new line as needed.

Well, they are complete.  And it's only an issue with the interpreter.  If you were to copy and paste the examples into a file, say example.py, and run that with python via:

python example.py

then they would work as they are supposed to.  If you backup in the tutorial to:

http://docs.python.org/3/tutorial/interpreter.html#interactive-mode

You will read an explanation of the interpreter prompts.

It may be that there is a way to make it clearer, but to update those examples would require similar adjustments all over the docs.  It would also only benefit the case where one were trying to run the code in the interpreter, and would make it more annoying to copy and paste into a file.  So, I don't think changing anything is worth it.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue16607>
_______________________________________


More information about the docs mailing list