From 89b9c8c620af731a122b2a34e0c0fa4e80dd1a61 Mon Sep 17 00:00:00 2001 From: Lucas Colley Date: Mon, 23 Sep 2024 10:29:23 +0100 Subject: [PATCH] DOC: atleast_nd: fix docstring syntax --- src/array_api_extra/_funcs.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/array_api_extra/_funcs.py b/src/array_api_extra/_funcs.py index e660f98..98c175b 100644 --- a/src/array_api_extra/_funcs.py +++ b/src/array_api_extra/_funcs.py @@ -14,15 +14,15 @@ def atleast_nd(x: Array, *, ndim: int, xp: ModuleType) -> Array: Parameters ---------- - x: array - ndim: int + x : array + ndim : int The minimum number of dimensions for the result. - xp: array_namespace + xp : array_namespace The standard-compatible namespace for `x`. Returns ------- - res: array + res : array An array with ``res.ndim`` >= `ndim`. If ``x.ndim`` >= `ndim`, `x` is returned. If ``x.ndim`` < `ndim`, `x` is expanded by prepending new axes