[docs] [issue13540] Document the Action API

Jason R. Coombs report at bugs.python.org
Tue Dec 6 15:56:35 CET 2011


New submission from Jason R. Coombs <jaraco at jaraco.com>:

In http://docs.python.org/dev/library/argparse.html#action, when describing an arbitrary action, the documentation states, "You can also specify an arbitrary action by passing an object that implements the Action API." This statement does not link to any documentation on the Action API and does not describe the API except to give an example.

Furthermore, the example contradicts the description. The description says "pass an object" but the example passes a class.

The documentation should clarify the text relating to the example and should document the expected interface for a custom action.

----------
assignee: docs at python
components: Documentation
messages: 148921
nosy: docs at python, jason.coombs
priority: low
severity: normal
status: open
title: Document the Action API
type: behavior
versions: Python 2.7, Python 3.2, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue13540>
_______________________________________


More information about the docs mailing list