Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optparse documentation: -- being collapsed to - in HTML #45527

Closed
hoffman mannequin opened this issue Sep 21, 2007 · 6 comments
Closed

optparse documentation: -- being collapsed to - in HTML #45527

hoffman mannequin opened this issue Sep 21, 2007 · 6 comments
Assignees
Labels
docs Documentation in the Doc dir

Comments

@hoffman
Copy link
Mannequin

hoffman mannequin commented Sep 21, 2007

BPO 1186
Nosy @gvanrossum, @freddrake, @birkenfeld

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2007-09-24.07:01:03.047>
created_at = <Date 2007-09-21.09:51:54.878>
labels = ['docs']
title = 'optparse documentation: -- being collapsed to - in HTML'
updated_at = <Date 2007-09-24.17:56:35.911>
user = 'https://bugs.python.org/hoffman'

bugs.python.org fields:

activity = <Date 2007-09-24.17:56:35.911>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2007-09-24.07:01:03.047>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2007-09-21.09:51:54.878>
creator = 'hoffman'
dependencies = []
files = []
hgrepos = []
issue_num = 1186
keywords = []
message_count = 6.0
messages = ['56074', '56077', '56105', '56106', '56107', '56118']
nosy_count = 5.0
nosy_names = ['gvanrossum', 'fdrake', 'gward', 'georg.brandl', 'hoffman']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1186'
versions = ['Python 2.5']

@hoffman
Copy link
Mannequin Author

hoffman mannequin commented Sep 21, 2007

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

@hoffman hoffman mannequin added the docs Documentation in the Doc dir label Sep 21, 2007
@gvanrossum
Copy link
Member

This is only a problem with the 2.5 latex docs.

@birkenfeld
Copy link
Member

Indeed, and I can remember trying to get around that, but didn't achieve
anything... I'll close it as won't fix.

@hoffman
Copy link
Mannequin Author

hoffman mannequin commented Sep 24, 2007

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.

@hoffman
Copy link
Mannequin Author

hoffman mannequin commented Sep 24, 2007

Also, see http://bugs.python.org/issue798006 which shows how to fix a
similar problem elsewhere in the docs.

@birkenfeld
Copy link
Member

Okay, applied that workaround in rev. 58243.

@birkenfeld birkenfeld assigned birkenfeld and unassigned freddrake Sep 24, 2007
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants