Skip to content

Fix markup #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions spec/API_specification/creation_functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ Returns evenly spaced values within the half-open interval `[start, stop)` as a

- the end of the interval. Default: `None`.

_Note: this function cannot guarantee that the interval does not include the `stop` value in those cases where `step` is not an integer and floating-point rounding errors affect the length of the output array._
.. note::

This function cannot guarantee that the interval does not include the `stop` value in those cases where `step` is not an integer and floating-point rounding errors affect the length of the output array.

- **step**: _Union\[ int, float ]_

- the distance between two adjacent elements (`out[i+1] - out[i]`). Default: `1`.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -49,7 +51,7 @@ Returns an uninitialized array having a specified `shape`.

- output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -69,7 +71,7 @@ Returns an uninitialized array with the same `shape` as an input array `x`.

- input array from which to derive the output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. If `dtype` is `None`, the output array data type must be inferred from `x`. Default: `None`.

Expand Down Expand Up @@ -97,7 +99,7 @@ Returns a two-dimensional array with ones on the `k`th diagonal and zeros elsewh

- 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`.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -121,7 +123,7 @@ Returns a new array having a specified `shape` and filled with `fill_value`.

- fill value.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -145,7 +147,7 @@ Returns a new array filled with `fill_value` and having the same `shape` as an i

- fill value.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. If `dtype` is `None`, the output array data type must be inferred from `x`. Default: `None`.

Expand Down Expand Up @@ -175,7 +177,7 @@ Returns evenly spaced numbers over a specified interval.

- number of samples. Must be a non-negative integer value; otherwise, the function must raise an exception.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -199,7 +201,7 @@ Returns a new array having a specified `shape` and filled with ones.

- output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -219,7 +221,7 @@ Returns a new array filled with ones and having the same `shape` as an input arr

- input array from which to derive the output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. If `dtype` is `None`, the output array data type must be inferred from `x`. Default: `None`.

Expand All @@ -239,7 +241,7 @@ Returns a new array having a specified `shape` and filled with zeros.

- output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. Default: `None`.

Expand All @@ -259,7 +261,7 @@ Returns a new array filled with zeros and having the same `shape` as an input ar

- input array from which to derive the output array shape.

- **dtype**: _Optional\[ _<dtype>_ ]_
- **dtype**: _Optional\[ <dtype> ]_

- output array data type. If `dtype` is `None`, the output array data type must be inferred from `x`. Default: `None`.

Expand Down