summaryrefslogtreecommitdiffstats
path: root/Misc
diff options
context:
space:
mode:
authorMartin Panter <vadmium+py@gmail.com>2016-04-05 07:37:22 (GMT)
committerMartin Panter <vadmium+py@gmail.com>2016-04-05 07:37:22 (GMT)
commit0f7673943a4ad633c59071b24b1f170a0df442c3 (patch)
tree7223797e0244f74c79bc482e8390185202a022c4 /Misc
parentcc71a795df4986bca5f88ce1e30f81608ca7387d (diff)
downloadcpython-0f7673943a4ad633c59071b24b1f170a0df442c3.zip
cpython-0f7673943a4ad633c59071b24b1f170a0df442c3.tar.gz
cpython-0f7673943a4ad633c59071b24b1f170a0df442c3.tar.bz2
Issue #6953: Rearrange and expand Readline module documentation
* Group functions into six new subsections * Document the underlying Readline function or variable accessed * get_history_length() returns the history file limit * clear_history() is conditionally compiled in * Clarify zero and one bases for history item indexes * parse_and_bind() uses its argument directly as an init line * Change "command line" to "line buffer" for consistency * read_init_file() also executes the file * read_history_file() replaces the previous history * write_history_file() overwrites any existing file * Differentiate history file lines from history list items, which could be multi-line * Add more information about completion, also addressing Issue #10796 * libedit (Editline) may be used on any platform; detection is OS X specific
Diffstat (limited to 'Misc')
-rw-r--r--Misc/NEWS4
1 files changed, 4 insertions, 0 deletions
diff --git a/Misc/NEWS b/Misc/NEWS
index b695831..7027b30 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -340,6 +340,10 @@ Library
Documentation
-------------
+- Issue #6953: Rework the Readline module documentation to group related
+ functions together, and add more details such as what underlying Readline
+ functions and variables are accessed.
+
- Issue #23606: Adds note to ctypes documentation regarding cdll.msvcrt.
- Issue #25500: Fix documentation to not claim that __import__ is searched for