[New-bugs-announce] [issue6953] readline documenation needs work

[Ronald Oussoren]

New submission from Ronald Oussoren <ronaldoussoren at mac.com>:

The documentation for the readline module is a bit too minimal.

1) function 'add_history' is described at the end of the documentation,
   not near the other functions for manipulation the history stack.

2) the index for remove_history_item and replace_history_item is 0-
based,
   while the index for get_history_item is 1-based.

The latter is a confusing API in the underlying readline library and 
should IMO be described in Python's documentation.

(If readline were a new addition to the stdlib I'd prefer to fix the 
interface, but that would have too many backward compatibility issues at 
this point in time).

----------
assignee: georg.brandl
components: Documentation
messages: 92893
nosy: georg.brandl, ronaldoussoren
severity: normal
status: open
title: readline documenation needs work
type: feature request
versions: Python 2.7, Python 3.2

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