Skip to content

Commit f1814ba

Browse files
authored
Merge pull request #56 from aschampion/patch-1
Copy edit README
2 parents be3a817 + 0ea2fa3 commit f1814ba

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ rust-numpy
44
[![Build status](https://ci.appveyor.com/api/projects/status/bjaru43c7t1alx2x/branch/master?svg=true)](https://ci.appveyor.com/project/kngwyu/rust-numpy/branch/master)
55
[![Crate](http://meritbadge.herokuapp.com/numpy)](https://crates.io/crates/numpy)
66

7-
Rust binding of NumPy C-API
7+
Rust bindings for the NumPy C-API
88

99
API documentation
1010
-------------
11-
- [Latest release(possibly 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

@@ -20,18 +20,18 @@ https://github.com/PyO3/pyo3/blob/master/build.rs for minimum required version)
2020
- [ndarray](https://github.com/bluss/ndarray) for rust-side matrix library
2121
- [pyo3](https://github.com/PyO3/pyo3) for cpython binding
2222
- and more (see [Cargo.toml](Cargo.toml))
23-
- [numpy](http://www.numpy.org/) installed in your python environments(e.g. via `pip install numpy`)
23+
- [numpy](http://www.numpy.org/) installed in your python environments (e.g., via `pip install numpy`)
2424

2525
**Note**
26-
From 0.3, we migrated from rust-cpython to pyo3.
26+
Starting from 0.3, rust-numpy migrated from rust-cpython to pyo3.
2727
If you want to use rust-cpython, use version 0.2.1 from crates.io.
2828

2929

3030
Example
3131
---------
3232

3333

34-
## Exec python program and get data
34+
## Execute a Python program from Rust and get results
3535

3636
``` toml
3737
[package]
@@ -71,9 +71,9 @@ fn main_<'py>(py: Python<'py>) -> PyResult<()> {
7171
}
7272
```
7373

74-
## Write Python module by rust
74+
## Write a Python module in Rust
7575

76-
Please see [example](example) directory for a complete example
76+
Please see the [example](example) directory for a complete example
7777

7878
```toml
7979
[lib]
@@ -101,7 +101,7 @@ use pyo3::prelude::{pymodinit, PyModule, PyResult, Python};
101101
#[pymodinit]
102102
fn rust_ext(py: Python, m: &PyModule) -> PyResult<()> {
103103
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
104-
// You **must** write this sentence for PyArray type checker working correctly
104+
// You **must** write this statement for the PyArray type checker to work correctly
105105
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
106106
let _np = PyArrayModule::import(py)?;
107107

@@ -138,7 +138,7 @@ fn rust_ext(py: Python, m: &PyModule) -> PyResult<()> {
138138

139139
Contribution
140140
-------------
141-
This project is in pre-alpha version.
141+
This project is still in pre-alpha.
142142
We need your feedback. Don't hesitate to open [issues](https://github.com/termoshtt/rust-numpy/issues)!
143143

144144
Version

example/extensions/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use pyo3::prelude::{pymodinit, PyModule, PyResult, Python};
99
#[pymodinit]
1010
fn rust_ext(py: Python, m: &PyModule) -> PyResult<()> {
1111
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12-
// You **must** write this sentence for PyArray type checker working correctly
12+
// You **must** write this statement for the PyArray type checker to work correctly
1313
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1414
let _np = PyArrayModule::import(py)?;
1515

0 commit comments

Comments
 (0)