aboutsummaryrefslogtreecommitdiff
path: root/qolab/tableflow/__init__.py
diff options
context:
space:
mode:
authorEugeniy E. Mikhailov <evgmik@gmail.com>2024-07-13 18:54:07 -0400
committerEugeniy E. Mikhailov <evgmik@gmail.com>2024-07-13 18:55:08 -0400
commit0a731c74d16343c87b660f0f7908c97c044fe238 (patch)
tree12e1504ab1870bfa1987656ceaa4a3ab85d4902c /qolab/tableflow/__init__.py
parent34f2829170a81c477e2416ceeeb32691722888d8 (diff)
downloadqolab-0a731c74d16343c87b660f0f7908c97c044fe238.tar.gz
qolab-0a731c74d16343c87b660f0f7908c97c044fe238.zip
improve readability of doc string
Diffstat (limited to 'qolab/tableflow/__init__.py')
-rw-r--r--qolab/tableflow/__init__.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/qolab/tableflow/__init__.py b/qolab/tableflow/__init__.py
index 4c81a34..d185d6f 100644
--- a/qolab/tableflow/__init__.py
+++ b/qolab/tableflow/__init__.py
@@ -97,19 +97,19 @@ def isRedoNeeded(row, cols2check):
def reflowTable(tIn, tOut, process_row_func=None, postProcessedColums=None, extraInfo=None, redo=False):
"""Reflow/update table tOut in place based on the inputs specified in table tIn.
- Effectively maps unprocessed rows to 'process_row_func'.
+ Effectively maps unprocessed rows to ``process_row_func``.
Parameters
==========
postProcessedColums : list of strings
List of column names which need to be generated
extraInfo : dictionary (optional)
- Dictionary of additional parameter supplied to `process_row_func`
+ Dictionary of additional parameter supplied to ``process_row_func``
process_row_func : function
- Function which will take a row from the input table and generate
+ Function which will take a row from the input table and generate
row with post processed entries (columns).
Expected to have signature like:
- rowOut = process_row_func(rowIn, extraInfo=userInfo)
+ ``rowOut = process_row_func(rowIn, extraInfo=userInfo)``
redo : True or False (default)
Flag indicating if reflow is needed unconditionally
(i.e. True forces reflow of all entries).