[issue16607] Bad examples in documentation

[John Hampton]

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[myreallycoolname]

myreallycoolname 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.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[Ezio Melotti]

Changes by Ezio Melotti :


--
nosy: +ezio.melotti
stage:  -> committed/rejected

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[Daniel Urban]

Daniel Urban added the comment:

As John Hampton have explained it, the documentation is actually correct.

--
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[John Hampton]

John Hampton added the comment:

The documentation is correct.  The problem that you seem to be having are due 
to copy and pasting in the interpreter.

The source of you first error is that after you copy

>>> def scope_test():
... def do_local():
... spam = "local spam"
... def do_nonlocal():
... nonlocal spam
... spam = "nonlocal spam"
... def do_global():
... global spam
... spam = "global spam"
... 

into the interpreter, you press enter and the blank line tells the interpreter 
that you're done defining the class.  However, if you look at the docs, the 
following statements:

spam = "test spam"
do_local()
print("After local assignment:", spam)
do_nonlocal()
print("After nonlocal assignment:", spam)
do_global()
print("After global assignment:", spam)

are supposed to be part of the class.  A similar issue exists for the issues 
you're experiencing with the loops.  Except it's the opposite.  In this case:

>>> for element in [1, 2, 3]:
... print(element)
... for element in (1, 2, 3):
  File "", line 3
for element in (1, 2, 3):
  ^
SyntaxError: invalid syntax

the interpreter is expecting a blank line after the print statement to indicate 
that the loop is done.  Since the second loop starts on the lien after "print", 
it thinks there is an indentation error.

--
nosy: +pacopablo

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[myreallycoolname]

myreallycoolname added the comment:

I am updating my bug report unfortunatly I am unable to give you a specific 
link due to the fact that I can not find the python3.2 documentation online. I 
do assure you that the docs from my computer are for python3.2 (as I have no 
other docs installed.) To find the docs I'm complaining about go to the index 
select tutorial and click on the classes section. The bad code along with the 
start of the chapter it is located in and the trace backs follow. Please note 
that errors are cumulative. In other words if you use variable a and variable a 
has no value (not created deffined etc.) then every time you use it you will 
get an error. Code follows:



9.2.1. Scopes and Namespaces Example
This is an example demonstrating how to reference the different scopes and 
namespaces, and howglobal and nonlocal affect variable binding:





>>> def scope_test():
... def do_local():
... spam = "local spam"
... def do_nonlocal():
... nonlocal spam
... spam = "nonlocal spam"
... def do_global():
... global spam
... spam = "global spam"
... 
SyntaxError: no binding for nonlocal 'spam' found
>>> spam = "test spam"
  File "", line 1
spam = "test spam"
^
IndentationError: unexpected indent
>>> do_local()
  File "", line 1
do_local()
^
IndentationError: unexpected indent
>>> print("After local assignment:", spam)
  File "", line 1
print("After local assignment:", spam)
^
IndentationError: unexpected indent
>>> do_nonlocal()
  File "", line 1
do_nonlocal()
^
IndentationError: unexpected indent
>>> print("After nonlocal assignment:", spam)
  File "", line 1
print("After nonlocal assignment:", spam)
^
IndentationError: unexpected indent
>>> do_global()
  File "", line 1
do_global()
^
IndentationError: unexpected indent
>>> print("After global assignment:", spam)
  File "", line 1
print("After global assignment:", spam)
^
IndentationError: unexpected indent
>>> 
>>> scope_test()
Traceback (most recent call last):
  File "", line 1, in 
NameError: name 'scope_test' is not defined
>>> print("In global scope:", spam)
Traceback (most recent call last):
  File "", line 1, in 
NameError: name 'spam' is not defined




9.3.3. Instance Objects
Now what can we do with instance objects? The only operations understood by 
instance objects are attribute references. There are two kinds of valid 
attribute names, data attributes and methods.
data attributes correspond to “instance variables” in Smalltalk, and to “data 
members” in C++. Data attributes need not be declared; like local variables, 
they spring into existence when they are first assigned to. For example, if x 
is the instance of MyClass created above, the following piece of code will 
print the value 16, without leaving a trace:





>>> x.counter = 1
>>> while x.counter < 10:
... x.counter = x.counter * 2
... print(x.counter)
  File "", line 3
print(x.counter)
^
SyntaxError: invalid syntax
>>> del x.counter


9.9. Iterators
By now you have probably noticed that most container objects can be looped over 
using a forstatement:




>>> for element in [1, 2, 3]:
... print(element)
... for element in (1, 2, 3):
  File "", line 3
for element in (1, 2, 3):
  ^
SyntaxError: invalid syntax
>>> print(element)
  File "", line 1
print(element)
^
IndentationError: unexpected indent
>>> for key in {'one':1, 'two':2}:
... print(key)
... for char in "123":
  File "", line 3
for char in "123":
  ^
SyntaxError: invalid syntax
>>> print(char)
  File "", line 1
print(char)
^
IndentationError: unexpected indent
>>> for line in open("myfile.txt"):
... print(line)
... 
Traceback (most recent call last):
  File "", line 1, in 
IOError: [Errno 2] No such file or directory: 'myfile.txt'
>>> 



This is one html page of errors not just one section. You may also want to 
check the python 3.3 docs for these errors.

--
status: closed -> open

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[Daniel Urban]

Daniel Urban added the comment:

Both work fine.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[myreallycoolname]

myreallycoolname added the comment:

I'm no expert so I'm not sure which it is but try these:

>>> class Complex:
... def __init__(self, realpart, imagpart):
... self.r = realpart
... self.i = imagpart
...

class Bag:
def __init__(self):
self.data = []
def add(self, x):
self.data.append(x)
def addtwice(self, x):
self.add(x)
self.add(x)

If that's not it wait and I'll submit a new and better bug report or add to the 
existing one.

> - Original Message -
> From: myreallycoolname
> Sent: 12/04/12 04:12 PM
> To: do...@mail.com
> Subject: [issue16607] Bad examples in documentation
> 
> myreallycoolname added the comment:
> 
> Sorry about that. You will unfortunatly have to wait as I'm not on a computer 
> that has python installed currently.
> 
> > - Original Message -
> > From: Daniel Urban
> > Sent: 12/04/12 02:00 PM
> > To: do...@mail.com
> > Subject: [issue16607] Bad examples in documentation
> > 
> > Daniel Urban added the comment:
> > 
> > Could you please point to a specific example which is incorrect? Thank you.
> > 
> > --
> > nosy: +daniel.urban
> > 
> > ___
> > Python tracker 
> > <http://bugs.python.org/issue16607>
> > ___
> >
> 
> --
> 
> ___
> Python tracker 
> <http://bugs.python.org/issue16607>
> ___
>

--

___
Python tracker 
<http://bugs.python.org/issue16607>
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[myreallycoolname]

myreallycoolname added the comment:

Sorry about that. You will unfortunatly have to wait as I'm not on a computer 
that has python installed currently.

> - Original Message -
> From: Daniel Urban
> Sent: 12/04/12 02:00 PM
> To: do...@mail.com
> Subject: [issue16607] Bad examples in documentation
> 
> Daniel Urban added the comment:
> 
> Could you please point to a specific example which is incorrect? Thank you.
> 
> --
> nosy: +daniel.urban
> 
> ___
> Python tracker 
> <http://bugs.python.org/issue16607>
> ___
>

--

___
Python tracker 
<http://bugs.python.org/issue16607>
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[Georg Brandl]

Georg Brandl added the comment:

I had a look and can't see an example in the "Classes" doc where self might not 
be defined.  Please reopen with a concrete pointer if you think otherwise.

--
nosy: +georg.brandl
resolution:  -> invalid
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[Daniel Urban]

Daniel Urban added the comment:

Could you please point to a specific example which is incorrect? Thank you.

--
nosy: +daniel.urban

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16607] Bad examples in documentation

[myreallycoolname]

New submission from myreallycoolname:

The doumentation examples imn the tutorial in python3.2 are at lest in part 
invalid. I was having trouble understanding the documentation so I pulled out 
my pthony interperator and pluged in one of tyhe examples.
Just as I thought self was not defined.
You can't learn python if the docs are bad.
Please review the examples under classes to make sure they are all correct.

--
assignee: docs@python
components: Documentation
messages: 176927
nosy: docs@python, myreallycoolname
priority: normal
severity: normal
status: open
title: Bad examples in documentation
versions: Python 3.2

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com