about summary refs log tree commit diff
path: root/saneterm
diff options
context:
space:
mode:
authorSören Tempel <soeren+git@soeren-tempel.net>2021-05-24 09:10:02 +0200
committerSören Tempel <soeren+git@soeren-tempel.net>2021-05-24 09:10:02 +0200
commit1c1ce31cdc317a3bdd44f31d9b7a28654c7d55e9 (patch)
treea1b2a97b945430347c441e4e9c30dff9348e34d5 /saneterm
parent7b09f7dd48a33f0ee02f80a3e87abca5799466f5 (diff)
history: add docstring to History class
Diffstat (limited to 'saneterm')
-rw-r--r--saneterm/history.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/saneterm/history.py b/saneterm/history.py
index 92f150d..8e54bd0 100644
--- a/saneterm/history.py
+++ b/saneterm/history.py
@@ -10,6 +10,10 @@ SIZE_ENV = "HISTSIZE"
 HISTORY_FN = "history.db"
 
 class History():
+    """History provides a single database for storing line-based editing
+       histories on a per-executable basis. The current executable is
+       determined using tcgetpgrp(3) on a given file descriptior."""
+
     __schema = """
         CREATE TABLE IF NOT EXISTS history (exe TEXT, entry TEXT)
     """