[issue6953] readline documenation needs work

Changes by Hideaki Takahashi : -- nosy: +hideaki_t ___ Python tracker ___ ___

[issue6953] readline documenation needs work

Martin Panter added the comment: This patch addresses the following points: 1: Moved add_history() into new “History file” section with related functions. 2: Documented that remove_ and replace_history_item() are zero-based. 3: Documented that get_history_item() is one-based. 4: Listed the

[issue6953] readline documenation needs work

Changes by Martin Panter : -- stage: -> patch review versions: +Python 3.6 ___ Python tracker ___

[issue6953] readline documenation needs work

Changes by Gabi Davar : -- nosy: +Gabi.Davar ___ Python tracker ___ ___

[issue6953] readline documenation needs work

Andy Maier added the comment: I would like to revive this issue. From the discussion, it seems to me that the following changes in the Python Library documentation would make sense: 1. Move add_history() higher up in the sequence of functions, for example to after write_history_file(). 2.

[issue6953] readline documenation needs work

stefanholek ste...@epy.co.at added the comment: To be zero-based, get_history_item would need to look like: diff --git a/rl/readline.c b/rl/readline.c index 33e9905..800bc00 100644 --- a/rl/readline.c +++ b/rl/readline.c @@ -559,7 +559,7 @@ get_history_item(PyObject *self, PyObject *args)

[issue6953] readline documenation needs work

Alexander Belopolsky alexander.belopol...@gmail.com added the comment: On Tue, Mar 9, 2010 at 4:24 PM, stefanholek rep...@bugs.python.org wrote: .. To be zero-based, get_history_item would need to look like: .. +       if ((hist_ent = history_get(history_base + idx))) Did you test this with

[issue6953] readline documenation needs work

Ronald Oussoren ronaldousso...@mac.com added the comment: Changing get_history_item to be 0-based would be a backward incompatible change. The point of my report is that the documentation of the readline documentation should mention how the APIs actually behave, you currently have to hunt down

[issue6953] readline documenation needs work

Changes by Alexander Belopolsky alexander.belopol...@gmail.com: -- nosy: +Alexander.Belopolsky ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue6953 ___

[issue6953] readline documenation needs work

Changes by Éric Araujo mer...@netwok.org: -- nosy: +merwok ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue6953 ___ ___ Python-bugs-list mailing

[issue6953] readline documenation needs work

New submission from Ronald Oussoren ronaldousso...@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