Skip to content

Commit ae340f2

Browse files
committed
fix typos
1 parent b9cf97a commit ae340f2

File tree

5 files changed

+29
-25
lines changed

5 files changed

+29
-25
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.words": [
3+
"chrono"
4+
]
5+
}

src/basic/basic_data_plotting.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
In this section, let's use Plotters to produce different types of Plotting.
44
Generally speaking, the API `ChartContext::draw_series` provides the functionality
5-
to draw any types of chart. In the following parts, let's dicuss how to use it to
5+
to draw any types of chart. In the following parts, let's discuss how to use it to
66
render different types of plots.
77

88
## Line series
99

10-
The following code demostrate how to draw a line series with Plotters
10+
The following code demonstrate how to draw a line series with Plotters
1111

1212
```rust
1313
use plotters::prelude::*;
@@ -38,8 +38,8 @@ It should produce the following image
3838

3939
## Scatter Plot
4040

41-
The following code demostrate how we can crate a scatter plot and use different pointing elements.
42-
In the example, we use `Circle` and `TriagnleMarker` pointing element for two different series.
41+
The following code demonstrate how we can crate a scatter plot and use different pointing elements.
42+
In the example, we use `Circle` and `TriangleMarker` pointing element for two different series.
4343

4444
In this example, we assume there are `DATA1` and `DATA2` defined. See the source for the details.
4545

@@ -78,7 +78,7 @@ And this will produce the following image.
7878

7979
## Area chart
8080

81-
The following demo demostrate how we can draw an area chart.
81+
The following demo demonstrate how we can draw an area chart.
8282

8383
```rust
8484
use plotters::prelude::*;
@@ -116,13 +116,13 @@ Result image:
116116

117117
## Histogram
118118

119-
In practise, the histogram can be two things:
119+
In practice, the histogram can be two things:
120120

121121
1. A bar plot
122122
2. Or a bar plot that shows the distribution of values
123123

124124
For a bar plot, we can simply create with a iterator that yields a series of
125-
rectangle. The following code demostrates how. The function `Rectangle::margin`
125+
rectangle. The following code demonstrates how. The function `Rectangle::margin`
126126
is used to set a pixel based margin for the rectangle element.
127127

128128
```rust
@@ -157,7 +157,7 @@ Result image:
157157

158158
![2.8.png](../../images/2.8.png)
159159

160-
Similary, the following code draws a vertical bar chart.
160+
Similarly, the following code draws a vertical bar chart.
161161

162162
```rust
163163
use plotters::prelude::*;
@@ -191,7 +191,7 @@ Result image:
191191

192192
![2.9.png](../../images/2.9.png)
193193

194-
For the second type of histogram, there's a `Histograma` series type is defined for this purpose.
194+
For the second type of histogram, there's a `Histogram` series type is defined for this purpose.
195195

196196
## Time Series Chart
197197

@@ -246,7 +246,7 @@ Result image:
246246

247247
## Customized series
248248

249-
Plotters allows you draw abitrary types of series, even the one isn't built into the Plotters crate.
249+
Plotters allows you draw arbitrary types of series, even the one isn't built into the Plotters crate.
250250
Plotters uses a really simple abstraction for a data series: An iterator of drawable elements.
251251
Thus if you can make your own series an iterator of drawable element, it's a valid data series and can be
252252
draw on a figure.
@@ -255,7 +255,7 @@ draw on a figure.
255255

256256

257257

258-
## Mutiple Data Series
258+
## Multiple Data Series
259259

260260
By calling `draw_series` multiple time, Plotters is able to produce the multiple series plot.
261261
Thus, we don't limit the developer's ability to put different types of plot series onto the same
@@ -308,7 +308,7 @@ When you call `ChartContext::draw_series`, a result type that carries a handle t
308308
is returned and you can use it to add a series label to that.
309309

310310
After you complete the data plotting, `ChartContext::configure_series_label` can be called to configure and draw
311-
the collections of series label. The following example demostrate how.
311+
the collections of series label. The following example demonstrate how.
312312

313313
```rust
314314
use plotters::prelude::*;

src/basic/chart_components.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ the mesh grid, etc. The `ChartContext` type is able to draw those component auto
55

66
## Mesh
77

8-
The following code demostrate how we can use `ChartContext::configure_mesh` to add a mesh
8+
The following code demonstrate how we can use `ChartContext::configure_mesh` to add a mesh
99
to the chart.
1010

1111
```rust
@@ -37,7 +37,7 @@ To add axes to the plot, it requires two steps:
3737
1. Define the label area size when the `ChartContext` is created.
3838
2. Use `configure_mesh` to draw the chart components.
3939

40-
The following code demostrates how to add axes
40+
The following code demonstrates how to add axes
4141

4242
```rust
4343
use plotters::prelude::*;

src/intro/getting_started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Getting Started
22

3-
Let's have a quick walkthrough on how to produce a data plot with Plotters.
3+
Let's have a quick walk through on how to produce a data plot with Plotters.
44
This is an example that plotting the graph of a simple equation `y = sin(x)` to a PNG file.
55

6-
### Step 0 - Install prerequisite libraries to system
6+
## Step 0 - Install prerequisite libraries to system
77

88
Plotters may use some library installed on your system, depends on what operating system you are using.
99

@@ -16,7 +16,7 @@ command to install them.
1616

1717
* For Windows and OSX user: No prerequisite library is required.
1818

19-
### Step 1 - Add dependency to `cargo.toml`
19+
## Step 1 - Add dependency to `cargo.toml`
2020

2121
In order to use Plotters, add the following line to your `cargo.tmol`
2222

@@ -57,7 +57,7 @@ fn main() {
5757
}
5858
```
5959

60-
### Step 3 - Build and run
60+
## Step 3 - Build and run
6161

6262
Use the following command to build and run the example
6363

src/intro/introduction.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Plotters Develvoper's Guide
1+
# Plotters Developer Guide
22

33
Plotters is a drawing library aimed to expedite the production of high-quality data visualization in Rust.
44

55
Plotters supports various types of backend and provides a easy-to-use high level drawing API that
66
makes data visualization easy. The Plotters API is designed to be highly flexible and extensible.
77

8-
Plotters is able to render the data visualization as a static image, a GIF animation and even realtime rendering
9-
backed on WASM, Piston Window or GTK/Cario.
8+
Plotters is able to render the data visualization as a static image, a GIF animation and even real-time rendering
9+
backed on WASM, Piston Window or GTK/Cairo.
1010

1111
## Source code in this book
1212

@@ -20,19 +20,18 @@ cargo run --bin <example-name>
2020

2121
### FAQ List
2222

23-
1. Why the example just exits without any figure poping up?
23+
1. Why the example just exits without any figure popping up?
2424

2525
You should be table to find the output under `images` directory under the user's guide repository.
26-
The filename for the output is the defined in the example code.
26+
The filename for the output is the defined in the example code.
2727

2828
## API Docs
2929

3030
This book is a developer's guide for Plotters. You may also want the API reference, please go to [docs.rs](https://docs.rs/plotters).
3131

3232
## Interactive Tutorial
3333

34-
There's an interactive tutorial with Jupyter notebook + excvr availible, feel free to check the
35-
[statically rendered notebook](https://plotters-rs.github.io/plotters-doc-data/evcxr-jupyter-integration.html)
34+
There's an interactive tutorial with Jupyter notebook + excvr availible, feel free to check the [statically rendered notebook](https://plotters-rs.github.io/plotters-doc-data/evcxr-jupyter-integration.html)
3635
and follow the instruction to setup the interactive tutorial on your local.
3736

3837
## License and Source Code

0 commit comments

Comments
 (0)