Issue 1186: optparse documentation: -- being collapsed to - in HTML (original) (raw)

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/45527

classification

Title: optparse documentation: -- being collapsed to - in HTML
Type: Stage:
Components: Documentation Versions: Python 2.5

process

Status: closed Resolution: wont fix
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: fdrake, georg.brandl, gvanrossum, gward, hoffman
Priority: normal Keywords:

Created on 2007-09-21 09:51 by hoffman, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (6)
msg56074 - (view) Author: Michael Hoffman (hoffman) Date: 2007-09-21 09:51
See <http://docs.python.org/lib/optparse-callback-example-6.html> where it says 'either "-" or "-" can be option arguments'. One of these should be --. The same error occurs several times on the same page. Not a problem in the Optik docs at <http://optik.sourceforge.net/doc/1.5/callbacks.html>.
msg56077 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2007-09-21 16:48
This is only a problem with the 2.5 latex docs.
msg56105 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2007-09-24 07:01
Indeed, and I can remember trying to get around that, but didn't achieve anything... I'll close it as won't fix.
msg56106 - (view) Author: Michael Hoffman (hoffman) Date: 2007-09-24 08:23
At the very least could you change the "--" to be the verbatim class that shows up properly beneath? There has to be another solution that would result in the docs at least being correct even if we can't get LaTeX to do exactly what we want.
msg56107 - (view) Author: Michael Hoffman (hoffman) Date: 2007-09-24 08:37
Also, see http://bugs.python.org/issue798006 which shows how to fix a similar problem elsewhere in the docs.
msg56118 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2007-09-24 17:56
Okay, applied that workaround in rev. 58243.
History
Date User Action Args
2022-04-11 14:56:27 admin set github: 45527
2007-09-24 17:56:35 georg.brandl set assignee: fdrake -> georg.brandlmessages: +
2007-09-24 08:37:27 hoffman set messages: +
2007-09-24 08:23:45 hoffman set messages: +
2007-09-24 07:01:03 georg.brandl set status: open -> closednosy: + georg.brandlresolution: wont fixmessages: +
2007-09-21 16:48:03 gvanrossum set assignee: fdrakemessages: + nosy: + gvanrossum, fdrake
2007-09-21 09:51:54 hoffman create