From dd0f1c0cb36e79c6d24a096bf51e1bd79c5d011d Mon Sep 17 00:00:00 2001
From: Matthias Diener <mdiener@illinois.edu>
Date: Mon, 15 Mar 2021 16:35:39 -0500
Subject: [PATCH] add to docs
---
doc/reference.rst | 1 +
pytools/datatable.py | 17 +++++++++++++----
2 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/doc/reference.rst b/doc/reference.rst
index fce823a..8c7ccc2 100644
--- a/doc/reference.rst
+++ b/doc/reference.rst
@@ -1 +1,2 @@
.. automodule:: pytools
+.. automodule:: pytools.datatable
diff --git a/pytools/datatable.py b/pytools/datatable.py
index 71f092d..b9e8066 100644
--- a/pytools/datatable.py
+++ b/pytools/datatable.py
@@ -2,6 +2,9 @@ from pytools import Record
__doc__ = """
+An in-memory relational database table
+======================================
+
.. autoclass:: DataTable
"""
@@ -11,14 +14,20 @@ class Row(Record):
class DataTable:
- """An in-memory relational database table."""
+ """An in-memory relational database table.
+
+ .. automethod:: __init__
+ .. automethod:: copy
+ .. automethod:: deep_copy
+ .. automethod:: join
+ """
def __init__(self, column_names, column_data=None):
"""Construct a new table, with the given C{column_names}.
- @arg column_names: An indexable of column name strings.
- @arg column_data: None or a list of tuples of the same length as
- C{column_names} indicating an initial set of data.
+ :arg column_names: An indexable of column name strings.
+ :arg column_data: None or a list of tuples of the same length as
+ C{column_names} indicating an initial set of data.
"""
if column_data is None:
self.data = []
--
GitLab