numpy / numpy/numpy

DOC: Improve ma.asarray documentation

Open
#4,560 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: numpy.ma
Dominant language
Python
Stars
32.8k
Forks
12.8k
Avg merge
1d 7h
Merged PRs (30d)
197

Description

ma.asarray has an order keyword which is not used, nor available in masked_array. Also, ma.asanyarray doesn't have an order keyword, but is documented as having one.

See @charris comment at gh-4045.

Contributor guide

Open the contributing guide

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.

Research direction

Compare the documented signatures and keyword descriptions for ma.asarray and ma.asanyarray with the APIs, using the issue's reference to gh-4045 for context. Done means the documentation accurately reflects which order keywords are available, including the relationship to masked_array.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.