Docs updates.

ericsnekbytes · ericsnekbytes · commit 16bb4e0be4d2 · 2022-12-26T17:17:56.000-05:00
diff --git a/app_table_people.py b/app_table_people.py
@@ -29,7 +29,7 @@ def __init__(self, first, middle, last, age, height_mm):
 class PeopleModel(QAbstractTableModel):
     """Tells Qt how our person data corresponds to different rows/columns/cells.
 
-    From the Qt documentation:
+    From the Qt documentation (for editable tables):
       When subclassing QAbstractTableModel, you must implement rowCount(),
       columnCount(), and data(). Default implementations of the index()
       and parent() functions are provided by QAbstractTableModel.
diff --git a/app_table_word_pairs.py b/app_table_word_pairs.py
@@ -16,7 +16,14 @@
 
 
 class WordPairModel(QAbstractTableModel):
-    """Tells Qt how our word pair data corresponds to different rows/columns/cells."""
+    """Tells Qt how our word pair data corresponds to different rows/columns/cells.
+
+    From the Qt documentation (for display-only tables):
+      When subclassing QAbstractTableModel, you must implement rowCount(),
+      columnCount(), and data(). Default implementations of the index()
+      and parent() functions are provided by QAbstractTableModel.
+      Well behaved models will also implement headerData().
+    """
 
     def __init__(self, user_data):
         super().__init__()
@@ -93,14 +100,7 @@ def set_new_pair_data(self, user_data):
 
 
 class CustomWidget(QWidget):
-    """A widget that shows a simple table of word pairs
-
-    From the Qt documentation:
-      When subclassing QAbstractTableModel, you must implement rowCount(),
-      columnCount(), and data(). Default implementations of the index()
-      and parent() functions are provided by QAbstractTableModel.
-      Well behaved models will also implement headerData().
-    """
+    """A widget that shows a simple table of word pairs"""
 
     def __init__(self):
         super().__init__()
