Skip to content

Commit 7dae32c

Browse files
committed
SA04
1 parent 910ffc0 commit 7dae32c

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

pixi.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,6 @@ checks = [
302302
"all", # report on all checks, except the below
303303
"EX01", # most docstrings do not need an example
304304
"SA01", # data-apis/array-api-extra#87
305-
"SA04", # Missing description for See Also cross-reference
306305
"ES01", # most docstrings do not need an extended summary
307306
]
308307
exclude = [ # don't report on objects that match any of these regex

src/array_api_extra/testing.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ def lazy_xp_function( # type: ignore[no-any-explicit]
8181
8282
See Also
8383
--------
84-
patch_lazy_xp_functions
85-
jax.jit
84+
patch_lazy_xp_functions : Companion function to call from the test or fixture.
85+
jax.jit : JAX function to compile a function for performance.
8686
8787
Examples
8888
--------
@@ -159,8 +159,8 @@ def xp(request, monkeypatch):
159159
160160
See Also
161161
--------
162-
lazy_xp_function
163-
pytest.FixtureRequest
162+
lazy_xp_function : Tag a function to be tested on lazy backends.
163+
pytest.FixtureRequest : `request` test function parameter.
164164
"""
165165
globals_ = cast(dict[str, Any], request.module.__dict__) # type: ignore[no-any-explicit]
166166

0 commit comments

Comments
 (0)