Docs and changelog

UDST · Mar 29, 2019 · b584358 · b584358
1 parent 45ecb47
commit b584358
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## 0.2 (not yet released)
 
+#### 0.2.dev5 (2019-03-29)
+
+- adds new template: `urbansim_templates.data.ColumnFromExpression`
+
 #### 0.2.dev4 (2019-03-26)
 
 - adds new data management utilities: `utils.validate_table()`, `utils.validate_all_tables()`, `utils.merge_tables()`

diff --git a/docs/source/data-templates.rst b/docs/source/data-templates.rst
@@ -1,8 +1,8 @@
 Data template APIs
 ==================
 
-Discussion
-----------
+Usage
+-----
 
 Data templates help you load tables into `Orca <https://udst.github.io/orca>`__ or save tables or subsets of tables to disk. 
 
@@ -75,15 +75,22 @@ From Orca's perspective, tables set up using the :mod:`~urbansim_templates.data.
 Unlike the templates, Orca relies on user-specified "`broadcast <http://udst.github.io/orca/core.html#merge-api>`__" relationships to perform automatic merging of tables. :mod:`~urbansim_templates.data.LoadTable` does not register any broadcasts, because they're not needed if tables follow the schema rules above. So if you use these tables in non-template model steps, you may need to add broadcasts separately.
 
 
-LoadTable API
--------------
+LoadTable()
+-----------
 
 .. autoclass:: urbansim_templates.data.LoadTable
    :members:
 
 
-SaveTable API
--------------
+SaveTable()
+-----------
 
 .. autoclass:: urbansim_templates.data.SaveTable
    :members:
+
+
+ColumnFromExpression()
+----------------------
+
+.. autoclass:: urbansim_templates.data.ColumnFromExpression
+   :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,7 @@ UrbanSim Templates provides building blocks for Orca-based simulation models. It
 
 The library contains templates for common types of model steps, plus a tool called ModelManager that runs as an extension to the `Orca <https://udst.github.io/orca>`__ task orchestrator. ModelManager can register template-based model steps with the orchestrator, save them to disk, and automatically reload them for future sessions.
 
-v0.2.dev4, released March 26, 2019
+v0.2.dev5, released March 29, 2019
 
 
 Contents

diff --git a/urbansim_templates/data/column_from_expression.py b/urbansim_templates/data/column_from_expression.py
@@ -14,9 +14,9 @@ class ColumnFromExpression():
     """
     Template to register a column of derived data with Orca, based on an expression. The 
     column will be associated with an existing table. Values will be calculated lazily, 
-    only when the column is requested for a specific operation. 
+    only when the column is needed for a specific operation. 
     
-    The expression will be passed to ``df.eval()`` and can refer to other columns in the 
+    The expression will be passed to ``df.eval()`` and can refer to any columns in the 
     same table. See the Pandas documentation for further details.
     
     All the parameters can also be set as properties after creating the template