Skip to content

docs: array_api.rst limitations section is turning into a changelog; restructure after the array-API PRs land #1014

Description

@mwcraig

The "What limitations should I be aware of?" section of docs/array_api.rst has grown one bullet per array-API PR (nanmean/nanmedian fallbacks, median, sigma_func, Combiner.sigma_clipping, and block_reduce/block_average/block_replicate in #1009). Each bullet explains which implementation a function dispatches to and how it was arrived at, so the section now reads as a per-PR changelog rather than user documentation.

Review the section once the block functions (#1009), window filters, and host-copy policy PRs have landed, and restructure it around what a user needs to know:

  • one place that states the dispatch rule (numpy input keeps the astropy/scipy code path, every other library gets the array-API implementation) instead of restating it per function;
  • a short table of behavioural differences that matter to a user (dtype promotion of integer/bool input, NaN handling on all-NaN slices, boundary classification in sigma clipping, lazy-library maxiters advice);
  • move the "why" (which library refuses which operation) out of the user docs, into docstrings or developer notes, or drop it.

Raised from review of #1009 (#1009 (comment)). Do not fix this in #1009.

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions