summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2021-06-10 14:32:34 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2021-06-14 11:28:25 -0400
commit26820cd6b66221d094adb74ceb82974928dbdd91 (patch)
tree1cd50d7f7b0909bfac3b5c7751154ed58042c5cc
parent4661f8621fe4353ed13d3bd7a597243f43b353b4 (diff)
downloadcmd2-git-26820cd6b66221d094adb74ceb82974928dbdd91.tar.gz
Updated documentation about persistent history files
-rw-r--r--docs/features/history.rst9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/features/history.rst b/docs/features/history.rst
index c84b854c..22e205b4 100644
--- a/docs/features/history.rst
+++ b/docs/features/history.rst
@@ -20,8 +20,9 @@ the parsed :class:`cmd2.Statement` is appended to :data:`cmd2.Cmd.history`.
``cmd2`` adds the option of making this history persistent via optional
arguments to :meth:`cmd2.Cmd.__init__`. If you pass a filename in the
``persistent_history_file`` argument, the contents of :data:`cmd2.Cmd.history`
-will be pickled into that history file. We chose to use pickle instead of plain
-text so that we can save the results of parsing all the commands.
+will be written as compressed JSON to that history file. We chose this format
+instead of plain text to preserve the complete :class:`cmd2.Statement` object
+for each command.
.. note::
@@ -41,9 +42,7 @@ The :data:`cmd2.Cmd.history` attribute, the :class:`cmd2.history.History`
class, and the :class:`cmd2.history.HistoryItem` class are all part of the
public API for :class:`cmd2.Cmd`. You could use these classes to implement
write your own ``history`` command (see below for documentation on how the
-included ``history`` command works). If you don't like pickled history, you
-could implement your own mechanism for saving and loading history from a plain
-text file.
+included ``history`` command works).
For Users