Skip to content

docs: mention np.cumsum/np.cumprod on the relevant reference pages #986

@nickodell

Description

@nickodell

Issue with current documentation

Recently, while reviewing scipy/scipy#24198, the author of that PR said they were unable to find any cumulative sum function within the array API.

I was also unable to find this initially, because I was searching for the NumPy equivalent name, cumsum. Search link.

Idea or request for content

While it is understandable that the array API changes the name, it would be helpful if the pages for cumulative_sum and cumulative_prod mentions the equivalent NumPy function for people like me who don't know the new name of the function, so they can be found through search.

Example content for cumulative_sum:

Notes:

This function is similar to numpy.cumsum().

Example content for cumulative_prod:

Notes:

This function is similar to numpy.cumprod().

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions