Skip to content

Commit a1ac3c2

Browse files
committed
Minor doc cleanup
1 parent 5705c02 commit a1ac3c2

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ var y = pool.zeros([2, 2])
2424
linspace(y, 0, 1, 2)
2525
// y => [ 0, 0 ]
2626
// [ 1, 1 ]
27-
2827
```
2928

3029
## Installation
@@ -38,7 +37,7 @@ npm install ndarray-linspace
3837
#### `require('ndarray-linspace')([output,] start, end, steps[, options])`
3938
An array of equally spaced values.
4039

41-
Arguments:
40+
**Arguments**:
4241
- `output` (options): if provided, the destination array to be filled with values. If the number of dimensions is greater than one, then the length of the first dimension must match the number of values and the entire ndarray will be filled with the linspace corresponding to the index of the first dimension.
4342
- `start`: starting value of the interval
4443
- `end`: ending value of the interval
@@ -47,5 +46,7 @@ Arguments:
4746
- `dtype`: dtype of output array (only used if output array not specified)
4847
- `endpoint` (boolean): whether the output contains the endpoint of the interval
4948

49+
**Returns**: A reference to the output
50+
5051
## License
5152
© 2015 Ricky Reusser. MIT License.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ndarray-linspace",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "Fill an ndarray with equally spaced values",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)