Document array API functions

Open
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the array API functions documentation linked in the issue and inspect the existing docstrings that point to NumPy functions. Update each function's documentation to point to its standard implementation and include relevant notes; done when every array API function has a short, standard-linked docstring.

Written by the indexing model from the issue text.

Description

Low Priority

Right now the documentation for the API just points to the standard. https://data-apis.org/array-api-strict/api.html#array-api-functions

It would be useful to have a short docstring for each function that points to its standard implementation, and includes any other relevant notes. Right now the docstrings point to the corresponding numpy functions, but pointing to the standard would be more appropriate.

Dominant language
Python
Stars
34
Forks
14
Avg merge
3m
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from data-apis/array-api-strict

All issues in data-apis/array-api-strict

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.