summaryrefslogtreecommitdiffstats
path: root/Doc/library/readline.rst
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 /Doc/library/readline.rst
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 'Doc/library/readline.rst')
-rw-r--r--Doc/library/readline.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/readline.rst b/Doc/library/readline.rst
index eae0a6d..3ff6488 100644
--- a/Doc/library/readline.rst
+++ b/Doc/library/readline.rst
@@ -258,7 +258,9 @@ with a custom completer, a different set of word delimiters should be set.
Get the beginning or ending index of the completion scope.
These indexes are the *start* and *end* arguments passed to the
:c:data:`rl_attempted_completion_function` callback of the
- underlying library.
+ underlying library. The values may be different in the same
+ input editing scenario based on the underlying C readline implemtation.
+ Ex: libedit is known to behave differently than libreadline.
.. function:: set_completer_delims(string)