summaryrefslogtreecommitdiffstats
path: root/Modules/clinic
diff options
context:
space:
mode:
authorGregory P. Smith <greg@krypto.org>2021-02-12 20:04:46 (GMT)
committerGitHub <noreply@github.com>2021-02-12 20:04:46 (GMT)
commitfd053fdd39fbdf114b4218ea4309666bafa95788 (patch)
tree360827543b553179e7d8526506106076071874d8 /Modules/clinic
parent5ec7d535581bc99918e032891167a96abd224ed6 (diff)
downloadcpython-fd053fdd39fbdf114b4218ea4309666bafa95788.zip
cpython-fd053fdd39fbdf114b4218ea4309666bafa95788.tar.gz
cpython-fd053fdd39fbdf114b4218ea4309666bafa95788.tar.bz2
bpo-43172: readline now passes its tests when built against libedit (GH-24499)
bpo-43172: readline now passes its tests when built against libedit. Existing irreconcilable API differences remain in readline.get_begidx and readline.get_endidx behavior based on libreadline vs libedit use. A note about that has been documented.
Diffstat (limited to 'Modules/clinic')
-rw-r--r--Modules/clinic/readline.c.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/Modules/clinic/readline.c.h b/Modules/clinic/readline.c.h
index 80207ca..d1ee808 100644
--- a/Modules/clinic/readline.c.h
+++ b/Modules/clinic/readline.c.h
@@ -384,7 +384,7 @@ PyDoc_STRVAR(readline_remove_history_item__doc__,
"remove_history_item($module, pos, /)\n"
"--\n"
"\n"
-"Remove history item given by its position.");
+"Remove history item given by its zero-based position.");
#define READLINE_REMOVE_HISTORY_ITEM_METHODDEF \
{"remove_history_item", (PyCFunction)readline_remove_history_item, METH_O, readline_remove_history_item__doc__},
@@ -412,7 +412,9 @@ PyDoc_STRVAR(readline_replace_history_item__doc__,
"replace_history_item($module, pos, line, /)\n"
"--\n"
"\n"
-"Replaces history item given by its position with contents of line.");
+"Replaces history item given by its position with contents of line.\n"
+"\n"
+"pos is zero-based.");
#define READLINE_REPLACE_HISTORY_ITEM_METHODDEF \
{"replace_history_item", (PyCFunction)(void(*)(void))readline_replace_history_item, METH_FASTCALL, readline_replace_history_item__doc__},
@@ -563,7 +565,7 @@ PyDoc_STRVAR(readline_get_history_item__doc__,
"get_history_item($module, index, /)\n"
"--\n"
"\n"
-"Return the current contents of history item at index.");
+"Return the current contents of history item at one-based index.");
#define READLINE_GET_HISTORY_ITEM_METHODDEF \
{"get_history_item", (PyCFunction)readline_get_history_item, METH_O, readline_get_history_item__doc__},
@@ -683,4 +685,4 @@ readline_redisplay(PyObject *module, PyObject *Py_UNUSED(ignored))
#ifndef READLINE_CLEAR_HISTORY_METHODDEF
#define READLINE_CLEAR_HISTORY_METHODDEF
#endif /* !defined(READLINE_CLEAR_HISTORY_METHODDEF) */
-/*[clinic end generated code: output=cb44f391ccbfb565 input=a9049054013a1b77]*/
+/*[clinic end generated code: output=f7d390113b27989f input=a9049054013a1b77]*/