Skip to content

Commit

Permalink
Better docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
smmaurer committed Mar 12, 2019
1 parent 84f9de0 commit ee67fe2
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions urbansim_templates/data/column_from_expression.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,38 @@ class ColumnFromExpression():
only when the column is requested for a specific operation.
The expression will be passed to ``pd.eval()`` and can refer to other columns in the
table. See the Pandas documentation for further details.
same table. See the Pandas documentation for further details.
All the parameters can also be set as properties after creating the template
instance.
Parameters
----------
column_name : str, optional
Name of the Orca column to be registered. Must be provided to run the template.
Name of the Orca column to be registered. Required before running.
table : str, optional
Name of the Orca table the column will be associated with. Must be provided to
run the template.
Name of the Orca table the column will be associated with. Required before
running.
expression : str, optional
Expression for calculating values of the column. Must be provided to run the
template.
Expression for calculating values of the column. Required before running.
cache : bool, default False
Passed to ``orca.column()``.
Whether to cache column values after they are calculated.
cache_scope : 'step', 'iteration', or 'forever', default 'forever'
Passed to ``orca.table()``.
How long to cache column values for (ignored if ``cache`` is False).
name : str, optional
Name of the template instance and associated model step.
tags : list of str, optional
Tags, passed to ModelManager.
Tags to associate with the template instance.
autorun : bool, default True
Automatically run the template whenever it's registered with ModelManager.
Whether to run automatically when the template instance is registered with
ModelManager.
"""
def __init__(self,
Expand Down

0 comments on commit ee67fe2

Please sign in to comment.