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

OptionParser keyword arg 'epilog' not mentioned in the docs #52456

Closed
orsenthil opened this issue Mar 23, 2010 · 5 comments
Closed

OptionParser keyword arg 'epilog' not mentioned in the docs #52456

orsenthil opened this issue Mar 23, 2010 · 5 comments
Assignees
Labels
docs Documentation in the Doc dir

Comments

@orsenthil
Copy link
Member

BPO 8209
Nosy @orsenthil, @bitdancer

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/orsenthil'
closed_at = <Date 2010-03-29.19:27:35.452>
created_at = <Date 2010-03-23.08:44:39.951>
labels = ['docs']
title = "OptionParser keyword arg 'epilog' not mentioned in the docs"
updated_at = <Date 2010-03-29.19:27:35.451>
user = 'https://github.com/orsenthil'

bugs.python.org fields:

activity = <Date 2010-03-29.19:27:35.451>
actor = 'orsenthil'
assignee = 'orsenthil'
closed = True
closed_date = <Date 2010-03-29.19:27:35.452>
closer = 'orsenthil'
components = ['Documentation']
creation = <Date 2010-03-23.08:44:39.951>
creator = 'orsenthil'
dependencies = []
files = []
hgrepos = []
issue_num = 8209
keywords = []
message_count = 5.0
messages = ['101565', '101566', '101569', '101576', '101901']
nosy_count = 2.0
nosy_names = ['orsenthil', 'r.david.murray']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue8209'
versions = ['Python 2.6', 'Python 3.1', 'Python 2.7', 'Python 3.2']

@orsenthil
Copy link
Member Author

I was looking for some option in optparse module which will allow me to add custom help text after the generated help. Realized that OptionParser class has a keyword argument 'epilog' for the same purpose.
But this is not been explained in the documentation, other keyword args are covered.

@orsenthil orsenthil self-assigned this Mar 23, 2010
@orsenthil orsenthil added the docs Documentation in the Doc dir label Mar 23, 2010
@orsenthil
Copy link
Member Author

Fixed in revision 79329.

@orsenthil
Copy link
Member Author

merged into release26-maint branch - 79331

@bitdancer
Copy link
Member

See also bpo-8158.

@orsenthil
Copy link
Member Author

merged into py3k in r79333 and release31-maint revision 79490.
This specific issue can be closed.
But yes, I agree with bpo-8158, there is a lot in OptParse Module documentation that could be improved and be made more helpful. If I have any thing more, I shall add it as part of bpo-8158.

@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

2 participants