Skip to content

Commit

Permalink
Corrected README and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan-k committed Feb 22, 2021
1 parent f0baa89 commit 46b82f1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Add this to your `Cargo.toml`:

```toml
[dependencies]
argmin = "0.3.1"
argmin = "0.4.1"
```

### Optional features (recommended)
Expand All @@ -87,7 +87,7 @@ There are additional features which can be activated in `Cargo.toml`:

```toml
[dependencies]
argmin = { version = "0.3.1", features = ["ctrlc", "ndarrayl", "nalgebral"] }
argmin = { version = "0.4.1", features = ["ctrlc", "ndarrayl", "nalgebral"] }
```

These may become default features in the future. Without these features compilation to
Expand All @@ -96,7 +96,7 @@ These may become default features in the future. Without these features compilat
- `ctrlc`: Uses the `ctrlc` crate to properly stop the optimization (and return the current best
result) after pressing Ctrl+C.
- `ndarrayl`: Support for `ndarray`, `ndarray-linalg` and `ndarray-rand`.
- `nalgebral`: Support for [`nalgebra`](https://nalgebra.org)
- `nalgebral`: Support for [`nalgebra`](https://nalgebra.org).

### Running the tests

Expand Down
7 changes: 4 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
//!
//! ```toml
//! [dependencies]
//! argmin = "0.3.1"
//! argmin = "0.4.1"
//! ```
//!
//! ## Optional features (recommended)
Expand All @@ -88,7 +88,7 @@
//!
//! ```toml
//! [dependencies]
//! argmin = { version = "0.3.1", features = ["ctrlc", "ndarrayl"] }
//! argmin = { version = "0.4.1", features = ["ctrlc", "ndarrayl", "nalgebral"] }
//! ```
//!
//! These may become default features in the future. Without these features compilation to
Expand All @@ -97,10 +97,11 @@
//! - `ctrlc`: Uses the `ctrlc` crate to properly stop the optimization (and return the current best
//! result) after pressing Ctrl+C.
//! - `ndarrayl`: Support for `ndarray`, `ndarray-linalg` and `ndarray-rand`.
//! - `nalgebral`: Support for `nalgebra`.
//!
//! ## Running the tests
//!
//! Running the tests requires the `ndarrayl` feature to be enabled:
//! Running the tests requires the `ndarrayl` and feature to be enabled:
//!
//! ```bash
//! cargo test --features "ndarrayl"
Expand Down

0 comments on commit 46b82f1

Please sign in to comment.