Improve docs for elwise/op test utilities

Open
#126 0 comments 0 reactions 1 assignee View on GitHub

@honno is already working on this.

Since Jun 1, 2022.

Assessment

This issue has not been assessed yet.

Description

low priority

test_operators_and_elementwise_functions.py is the most complicated part of the test suite. That inherent complexity should be mitigated as much as possible via good docs. I wrote some broader docs in the file, but think docstrings similiar to the one seen in ph.assert_dtype() would be well-suited for the *_assert_against_refimpl() utilities.

https://github.com/data-apis/array-api-tests/blob/87834dd65744af21a0e3c9d2ed9f07a1f475bb54/array_api_tests/pytest_helpers.py#L82-L123

Dominant language
Python
Stars
74
Forks
54
Avg merge
4d 15h
Merged PRs (30d)
6

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-tests

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

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.