classification
Title: optparse Documentation References Example Files that do not Exist
Type: enhancement Stage:
Components: Documentation, Library (Lib) Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: MarkRoddy, georg.brandl
Priority: normal Keywords: patch

Created on 2009-11-28 03:12 by MarkRoddy, last changed 2009-12-28 08:48 by georg.brandl. This issue is now closed.

Files
File name Uploaded Description Edit
remove-reference.diff MarkRoddy, 2009-11-28 03:59 Patch to remove references to non-extistant files
reference-optik.diff MarkRoddy, 2009-11-28 04:01 Patch for referencing optik example files
example-inline.diff MarkRoddy, 2009-11-28 04:02 required_1.py integrated into doc
Messages (5)
msg95780 - (view) Author: Mark Roddy (MarkRoddy) * Date: 2009-11-28 03:12
In the 'Terminology' section of the optparse module documentation, under
the description of the term 'required option', a reference to example
implementations of this concept are stated to be available in two
example files of the source distribution:

"See examples/required_1.py and examples/required_2.py in the optparse
source distribution for two ways to implement required options with
optparse."

These two files do not appear to have ever been available with python 
but are found in the original 'Optik' distribution that this module is
derived from.  I am guessing that this is a result of the documentation
being copied when the module was added to the standard library as it
also appears in the Optik documentation almost verbatim:
http://optik.sourceforge.net/doc/1.5/tao.html

Suggest the reference to these files:
1) Be removed as to prevent confusion as to their existence/location
2) Be updated to point to the Optik source on source forge
3) Merge the examples in line with the documentation
or
4) Some other option I have not thought of
msg95781 - (view) Author: Mark Roddy (MarkRoddy) * Date: 2009-11-28 03:59
Patch which removes reference to example_1.py and example_2.py
msg95782 - (view) Author: Mark Roddy (MarkRoddy) * Date: 2009-11-28 04:01
Patch which references the original optik module when referring to
example required option modules.
msg95783 - (view) Author: Mark Roddy (MarkRoddy) * Date: 2009-11-28 04:02
Patch takes the contents of required_1.py from the optik source adds it
in the optparse documentation as well as removing references to the two
files.
msg96945 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-12-28 08:48
Thanks for the report. I removed the references in r77092.
History
Date User Action Args
2009-12-28 08:48:37georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg96945
2009-11-28 04:02:59MarkRoddysetfiles: + example-inline.diff

messages: + msg95783
2009-11-28 04:01:03MarkRoddysetfiles: + reference-optik.diff

messages: + msg95782
2009-11-28 03:59:27MarkRoddysetfiles: + remove-reference.diff
keywords: + patch
messages: + msg95781
2009-11-28 03:12:44MarkRoddycreate