Skip to content

Commit cb4fb83

Browse files
committed
Refactor documents
1 parent 546f978 commit cb4fb83

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ Rust binding of NumPy C-API
88

99
API documentation
1010
-------------
11-
- [Latest release(can be broken)](https://docs.rs/numpy)
11+
- [Latest release(possibly broken)](https://docs.rs/numpy)
1212
- [Current Master](https://rust-numpy.github.io/rust-numpy)
1313

1414

15-
Dependencies
15+
Requirements
1616
-------------
17-
- nightly version of rust compiler (see [pyo3](https://github.com/PyO3/pyo3))
17+
- current nightly rust (see https://github.com/PyO3/pyo3/issues/5 for nightly features, and
18+
https://github.com/PyO3/pyo3/blob/master/build.rs for minimum required version)
1819
- some rust libraries
1920
- [rust-ndarray](https://github.com/bluss/rust-ndarray) for rust-side matrix library
2021
- [pyo3](https://github.com/PyO3/pyo3) for cpython binding
@@ -23,7 +24,7 @@ Dependencies
2324

2425
**Note**
2526
From 0.3, we migrated from rust-cpython to pyo3.
26-
If you want rust-cpython, use version 0.2.1 from crates.io.
27+
If you want to use rust-cpython, use version 0.2.1 from crates.io.
2728

2829

2930
Example

src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
//! `rust-numpy` provides Rust interfaces for [numpy](http://www.numpy.org/) APIs,
2-
//! especially [ndarray](https://www.numpy.org/devdocs/reference/arrays.ndarray.html) class.
1+
//! `rust-numpy` provides Rust interfaces for [NumPy C APIs](https://docs.scipy.org/doc/numpy/reference/c-api.html),
2+
//! especially for [ndarray](https://www.numpy.org/devdocs/reference/arrays.ndarray.html) class.
33
//!
44
//! It uses [pyo3](https://github.com/PyO3/pyo3) for rust bindings to cpython, and uses
55
//! [ndarray](https://github.com/bluss/ndarray) for rust side matrix library.
66
//!
7-
//! For numpy dependency, it calls `import numpy.core` internally so you just need numpy
7+
//! For numpy dependency, it calls `import numpy.core` internally. So you just need numpy
88
//! installed by `pip install numpy` or other ways in your python environment.
99
//! You can use both system environment and `virtualenv`.
1010
//!

0 commit comments

Comments
 (0)