-
Notifications
You must be signed in to change notification settings - Fork 1
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Raising as part of JOSS review openjournals/joss-reviews/issues/6713
In the docstring for the simdec.tableau
function
simdec-python/src/simdec/visualization.py
Lines 191 to 212 in da28df6
def tableau( | |
*, | |
var_names: list[str], | |
statistic: np.ndarray, | |
states: list[int | list[str]], | |
bins: pd.DataFrame, | |
palette: np.ndarray, | |
) -> tuple[pd.DataFrame, Styler]: | |
"""Generate a table of statistics for all scenarios. | |
Parameters | |
---------- | |
var_names : list of str | |
Variables name. | |
states : list of int or list of str | |
For each variable, number of states. Can either be a scalar or a list. | |
``states=[2, 2]`` or ``states=[['a', 'b'], ['low', 'high']]`` | |
bins : DataFrame | |
Multidimensional bins. | |
palette : list of int of size (n, 4) | |
Ordered list of colours corresponding to each state. |
the argument statistic
does not have a corresponding entry in parameter list in docstring.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation