Skip to content

DOC: assert_allclose instead of xp_assert_close is recommended in Developer Guide #21717

Open
@DietBru

Description

In the "Test functions from numpy.testing" section of the Code and Documentation Style Guide the following quote can be found:

It is recommended to use one of assert_allclose,
assert_array_almost_equal_nulp or assert_array_max_ulp
instead of this function for more consistent floating point
comparisons.

For supporting the array API standard, wouldn't it preferable to recommend xp_assert_close and friends?

The context is this helpful review comment from @j-bowhay.

Metadata

Assignees

No one assigned

    Labels

    DXEverything related to making the experience of working on SciPy more pleasantDocumentationIssues related to the SciPy documentation. Also check https://github.com/scipy/scipy.orgarray typesItems related to array API support and input array validation (see gh-18286)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions