Skip to content

Potential error in apply_ufunc docstring for input_core_dims #1577

Closed
@nbren12

Description

@nbren12

The documentation for input_core_dims reads:

    input_core_dims : Sequence[Sequence], optional
        List of the same length as ``args`` giving the list of core dimensions
        on each input argument that should be broadcast. By default, we assume
        there are no core dimensions on any input arguments.

        For example ,``input_core_dims=[[], ['time']]`` indicates that all
        dimensions on the first argument and all dimensions other than 'time'
        on the second argument should be broadcast.

The first and second paragraphs seem contradictory to me. Shouldn't the first paragraph be changed to:

        List of the same length as ``args`` giving the list of core dimensions
        on each input argument that should *not* be broadcast. By default, we assume
        there are no core dimensions on any input arguments.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions