bpo-31537: Update readline documentation example. (GH-3925) (GH-3948)

Change the code example from using `get_history_length` to `get_current_history_length`.
(cherry picked from commit eeb5ffd54e56dd89a99c74eb512c36d62649cfec)

diff --git a/Doc/library/readline.rst b/Doc/library/readline.rst
index 54c54b461ce7e43ed006829a04b10dd5ad104601..837816e952ad566954c664b7b563df5615efbed8 100644 (file)
--- a/Doc/library/readline.rst
+++ b/Doc/library/readline.rst
@@ -312,13 +312,13 @@ sessions, by only appending the new history. ::
 
    try:
        readline.read_history_file(histfile)
-       h_len = readline.get_history_length()
+       h_len = readline.get_current_history_length()
    except FileNotFoundError:
        open(histfile, 'wb').close()
        h_len = 0
 
    def save(prev_h_len, histfile):
-       new_h_len = readline.get_history_length()
+       new_h_len = readline.get_current_history_length()
        readline.set_history_length(1000)
        readline.append_history_file(new_h_len - prev_h_len, histfile)
    atexit.register(save, h_len, histfile)

diff --git a/Misc/NEWS.d/next/Documentation/2017-10-08-23-02-14.bpo-31537.SiFNM8.rst b/Misc/NEWS.d/next/Documentation/2017-10-08-23-02-14.bpo-31537.SiFNM8.rst
new file mode 100644 (file)
index 0000000..9244d7e
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2017-10-08-23-02-14.bpo-31537.SiFNM8.rst
@@ -0,0 +1,2 @@
+Fix incorrect usage of ``get_history_length`` in readline documentation
+example code. Patch by Brad Smith.