469,286 Members | 2,522 Online
Bytes | Developer Community
New Post

Home Posts Topics Members FAQ

Post your question to a community of 469,286 developers. It's quick & easy.

Error in optparse documentation

In the python documentation section 14.3.2.6 (http://docs.python.org/
lib/optparse-generating-help.html) in the last line it is written

"options that have a default value can include %default in the help
string--optparse will replace it with str() of the option's default
value. If an option has no default value (or the default value is
None), %default expands to none."

However this is true only for python 2.4 and newer and not for older
versions. Though the documentation for optparse (section 14.3,
http://docs.python.org/lib/module-optparse.html) says that the module
is new for python 2.3, in this version a help string (default value =
intermediate) e.g.

help="interaction mode: novice, intermediate, or expert [default:
%default]"

prints

interaction mode: novice, intermediate, or expert [default: %default]

and not:

interaction mode: novice, intermediate, or expert [default:
intermediate]

Only in python 2.4 and newer do you see the help string print as

interaction mode: novice, intermediate, or expert [default:
intermediate]

I think the documentation should be modified so that it is made clear
that %default in the help string behaves as is claimed only in version
2.4 and higher.
O.S. used is RHEL 9

May 27 '07 #1
4 1126
Shatadal wrote:
In the python documentation section 14.3.2.6 (http://docs.python.org/
lib/optparse-generating-help.html) in the last line it is written

"options that have a default value can include %default in the help
string--optparse will replace it with str() of the option's default
value. If an option has no default value (or the default value is
None), %default expands to none."

However this is true only for python 2.4 and newer and not for older
versions.
The optparse module is externally maintained. You should file a
documentation bug at http://optik.sourceforge.net/

STeVe
May 27 '07 #2
On May 28, 7:54 am, Shatadal <gshata...@rediffmail.comwrote:
In the python documentation section 14.3.2.6 (http://docs.python.org/
lib/optparse-generating-help.html) in the last line it is written

"options that have a default value can include %default in the help
string--optparse will replace it with str() of the option's default
value. If an option has no default value (or the default value is
None), %default expands to none."

However this is true only for python 2.4 and newer and not for older
versions. Though the documentation for optparse (section 14.3,http://docs.python.org/lib/module-optparse.html) says that the module
is new for python 2.3, in this version a help string (default value =
intermediate) e.g.

help="interaction mode: novice, intermediate, or expert [default:
%default]"

prints

interaction mode: novice, intermediate, or expert [default: %default]

and not:

interaction mode: novice, intermediate, or expert [default:
intermediate]

Only in python 2.4 and newer do you see the help string print as

interaction mode: novice, intermediate, or expert [default:
intermediate]

I think the documentation should be modified so that it is made clear
that %default in the help string behaves as is claimed only in version
2.4 and higher.
Don't think, act; submit a doc patch: """
Please add the text "New in version 2.4." to the end of the last
bullet point in [the section that you quoted].
"""
and move on.

If you are maintaining software that must work on an older version of
Python, you need to read the docs for that version, as well as the
current docs -- you can't [reasonably] expect a birth certificate
attached to each paragraph :-)

May 27 '07 #3
In <11**********************@q75g2000hsh.googlegroups .com>, Shatadal
wrote:
I think the documentation should be modified so that it is made clear
that %default in the help string behaves as is claimed only in version
2.4 and higher.
Maybe something should be added for clarity but I don't think it's an
error in the docs. You are reading documentation for Python 2.5 and
expect everything in it to work in older versions too?

Pick the right documentation from http://www.python.org/doc/versions/

Ciao,
Marc 'BlackJack' Rintsch
May 28 '07 #4
On May 28, 2:19 am, Marc 'BlackJack' Rintsch <bj_...@gmx.netwrote:
In <1180302882.090651.235...@q75g2000hsh.googlegroups .com>, Shatadal
wrote:
I think the documentation should be modified so that it is made clear
that %default in the help string behaves as is claimed only in version
2.4 and higher.

Maybe something should be added for clarity but I don't think it's an
error in the docs. You are reading documentation for Python 2.5 and
expect everything in it to work in older versions too?

Pick the right documentation fromhttp://www.python.org/doc/versions/
Thanks Marc. I did not know that documentation for previous versions
existed.
>
Ciao,
Marc 'BlackJack' Rintsch

May 28 '07 #5

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

reply views Thread by Skip Montanaro | last post: by
4 posts views Thread by GMTaglia | last post: by
7 posts views Thread by Henry Ludemann | last post: by
3 posts views Thread by Tomi Silander | last post: by
1 post views Thread by sector119 | last post: by
7 posts views Thread by R. Bernstein | last post: by
1 post views Thread by tobiah | last post: by
reply views Thread by zhoujie | last post: by
reply views Thread by suresh191 | last post: by
By using this site, you agree to our Privacy Policy and Terms of Use.