Array API Compatibility as a separate section?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
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:
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review scipy/scipy#22609 and the proposed documentation example to understand the intended Array API compatibility information. A complete outcome would define whether this belongs in a separate section, what it should be called, and how it should be represented in numpydoc documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100