Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing parameter definition in docstring for simdec.tableau #32

Closed
matt-graham opened this issue May 22, 2024 · 1 comment
Closed

Missing parameter definition in docstring for simdec.tableau #32

matt-graham opened this issue May 22, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@matt-graham
Copy link
Contributor

matt-graham commented May 22, 2024

Raising as part of JOSS review openjournals/joss-reviews/issues/6713

In the docstring for the simdec.tableau function

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.

@tupui
Copy link
Member

tupui commented May 22, 2024

Thank you, fixed in cae9113

@tupui tupui closed this as completed May 22, 2024
@tupui tupui added the documentation Improvements or additions to documentation label May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants