473,372 Members | 898 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,372 software developers and data experts.

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 1268
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 thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

0
by: Skip Montanaro | last post by:
I'm trying to convert my brain from getopt to optparse. I want to refer to documentation similar to the regular library reference manual docs which concisely documents the Option and OptionParser...
4
by: GMTaglia | last post by:
Hi list, I'm trying to understand how really optparse work .. I've already read the documentation so please don't answer RTFM because I already did it twice :) Maybe someone have some...
7
by: Henry Ludemann | last post by:
I've been writing an optparse alternative (using getopt) that is at a stage where I'd be interested in people's opinions. It allows you to easily creating command line interfaces to existing...
3
by: Tomi Silander | last post by:
Hi, this must have been asked 1000 times (or nobody is as stupid as me), but since I could not find the answer, here is the question. My program mitvit.py: -------------- import optparse...
1
by: sector119 | last post by:
Hi I use optparse with callback action, my callback function return some value, but optparse does not store this value, options.callback_dest always is None. How can I store callback function...
7
by: R. Bernstein | last post by:
optparse is way cool, far superior and cleaner than other options processing libraries I've used. In the next release of the Python debugger revision, I'd like to add debugger options: --help...
5
by: Bob | last post by:
I'm playing around with optparse and created the code below. How do I move that to a function and what variable do I pass? >From the documentation it seems like "options.optparse_test" would have...
1
by: Pupeno | last post by:
Hello, I am doing some extreme use of optparse, that is, extending it as explained on http://docs.python.org/lib/optparse-other-reasons-to-extend-optparse.html I have subclassed OptionParser and...
1
by: tobiah | last post by:
In http://docs.python.org/lib/optparse-terminology.html The GNU project introduced "-" followed by a series of hyphen-separated words, e.g. "-file" or "-dry-run". These are the only two option...
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.