From 5d5f51a74f59e745b9e356ab89287360b8b40f71 Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Tue, 28 Sep 2021 23:06:27 +0200 Subject: [PATCH] disallow `k=None` for the `eye` function --- spec/API_specification/creation_functions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/API_specification/creation_functions.md b/spec/API_specification/creation_functions.md index 8adf44e1e..990ff6ae5 100644 --- a/spec/API_specification/creation_functions.md +++ b/spec/API_specification/creation_functions.md @@ -150,7 +150,7 @@ Returns a two-dimensional array with ones on the `k`th diagonal and zeros elsewh - number of columns in the output array. If `None`, the default number of columns in the output array is equal to `n_rows`. Default: `None`. -- **k**: _Optional\[ int ]_ +- **k**: _int_ - index of the diagonal. A positive value refers to an upper diagonal, a negative value to a lower diagonal, and `0` to the main diagonal. Default: `0`.