NCAS-CMS / NCAS-CMS/cf-python

Provide `cf.<method>(a, b)` as wrapper to `a.<method>(b)`

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

Nobody has claimed this yet.

API review (4.0.0)
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

... for methods where a and b are both input arrays (of course there may be other parameters but they are omitted here) and particularly when they are to be compared in some manner, as is the case for equals or allclose

This is a potential API extension proposed (by @davidhassell) to provide an API more consistent with NumPy, Dask and other libraries covered by the Python Array API Standard, where the former prescription is the standard, but there are arguments for either approach we both think.

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

No files, tests, or entry points are identified in the issue. First clarify the proposed API scope, including methods such as equals or allclose and any additional parameters; done would mean the supported cf.(a, b) form is defined and consistently equivalent to a.(b).

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.