Skip to content

Documentation for @resolve has broken example #1384

@Phrogz

Description

@Phrogz

The documentation for @resolve decorator includes this example code:

@parameterize_values(
    series_sum_1={"s1": "series_1", "s2": "series_2"},
    series_sum_2={"s1": "series_3", "s2": "series_4"},
)
def summation(df: pd.DataFrame, s1: str, s2: str) -> pd.Series:
    return df[s1] + df[s2]

However, that is incorrect usage of the @parameterize_values decorator. That is the usage for @parameterize decorator.

Steps to replicate behavior

  1. Go to the docs page

Additional context

This example was changed from @parameterize to @parametrize_values in commit 67f7918 17 months ago. I'm unsure if it was valid then, but I'm fairly certain it is not valid now.

Metadata

Metadata

Assignees

No one assigned

    Labels

    triagelabel for issues that need to be triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions