From 64d16ee8a75598fe7d0cf76cca460fb682943666 Mon Sep 17 00:00:00 2001 From: Armin Date: Sun, 22 Aug 2021 19:20:39 +0200 Subject: [PATCH] Update docs --- README.md | 6 ++++++ src/lib.rs | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19db9a7..76643dd 100644 --- a/README.md +++ b/README.md @@ -10,5 +10,11 @@ Data structure grid for rust. Provide a two dimensional data structure for rust Most of the functionality provided by the [std::vec::Vec](https://doc.rust-lang.org/std/vec/struct.Vec.html) type for one dimensional vectors is implemented for two dimensions in this crate. +To use *grid* with *no_std* import the library such as: + +``` toml +grid = { version = "*", default-features = false } +``` + - [documentation](https://docs.rs/grid/) - [library on crates.io](https://crates.io/crates/grid) diff --git a/src/lib.rs b/src/lib.rs index 97871c6..3431324 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -170,8 +170,8 @@ impl Grid { /// ``` /// /// will create a grid with the following layout: - /// [1,2,3] - /// [4,5,6] + /// \[1,2,3\] + /// \[4,5,6\] /// /// This example will fail, because `vec.len()` is not a multiple of `cols`: ///