Skip to content

Array API Compatibility as a separate section? #610

@mdhaber

Description

@mdhaber
Contributor

In scipy/scipy#22609, we're working on documenting support for array arguments beyond NumPy ndarrays. We're thinking of including something like this in the documentation of each class/function/method:

Image

Initially, we would probably put this sort of information in the Notes section, but as the ecosystem moves to support more backends, it was proposed that it might deserve a separate "Array API Compatibility" (or similar) section of the notes. Thoughts on adding such a section?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

        Participants

        @stefanv@mdhaber

        Issue actions

          Array API Compatibility as a separate section? · Issue #610 · numpy/numpydoc