fix(docs): fix some typo and grammar errors
This commit is contained in:
parent
e33bb22fde
commit
1a2dfd9d85
10
README.md
10
README.md
|
@ -1,5 +1,9 @@
|
||||||
# Orgize
|
# Orgize
|
||||||
|
|
||||||
|
[![Build Status](https://travis-ci.org/PoiScript/orgize.svg?branch=master)](https://travis-ci.org/PoiScript/orgize)
|
||||||
|
[![Crates.io](https://img.shields.io/crates/v/orgize.svg)](https://crates.io/crates/orgize)
|
||||||
|
[![Document](https://docs.rs/orgize/badge.svg)](https://docs.rs/orgize)
|
||||||
|
|
||||||
A Rust library for parsing orgmode files.
|
A Rust library for parsing orgmode files.
|
||||||
|
|
||||||
## Parse
|
## Parse
|
||||||
|
@ -21,7 +25,7 @@ _Section 2_
|
||||||
|
|
||||||
## Iter
|
## Iter
|
||||||
|
|
||||||
`Org::iter` function will return a iteractor of `Event`s, which is
|
`Org::iter` function will returns an iteractor of `Event`s, which is
|
||||||
a simple wrapper of `Element`.
|
a simple wrapper of `Element`.
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
|
@ -30,7 +34,7 @@ for event in org.iter() {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: whether an element is container or not, it will appears two times in a loop.
|
**Note**: whether an element is container or not, it will appears twice in one loop.
|
||||||
One as `Event::Start(element)`, one as `Event::End(element)`.
|
One as `Event::Start(element)`, one as `Event::End(element)`.
|
||||||
|
|
||||||
## Render html
|
## Render html
|
||||||
|
@ -53,7 +57,7 @@ assert_eq!(
|
||||||
|
|
||||||
## Render html with custom HtmlHandler
|
## Render html with custom HtmlHandler
|
||||||
|
|
||||||
To customize html rending, simply implementing `HtmlHandler` trait and passing
|
To customize html rendering, simply implementing `HtmlHandler` trait and passing
|
||||||
it to the `Org::html` function.
|
it to the `Org::html` function.
|
||||||
|
|
||||||
The following code demonstrates how to add a id for every headline and return
|
The following code demonstrates how to add a id for every headline and return
|
||||||
|
|
|
@ -21,7 +21,7 @@
|
||||||
//!
|
//!
|
||||||
//! # Iter
|
//! # Iter
|
||||||
//!
|
//!
|
||||||
//! [`Org::iter`] function will return a iteractor of [`Event`]s, which is
|
//! [`Org::iter`] function will returns an iteractor of [`Event`]s, which is
|
||||||
//! a simple wrapper of [`Element`].
|
//! a simple wrapper of [`Element`].
|
||||||
//!
|
//!
|
||||||
//! [`Org::iter`]: org/struct.Org.html#method.iter
|
//! [`Org::iter`]: org/struct.Org.html#method.iter
|
||||||
|
@ -45,7 +45,7 @@
|
||||||
//! }
|
//! }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! **Note**: whether an element is container or not, it will appears two times in a loop.
|
//! **Note**: whether an element is container or not, it will appears twice in one loop.
|
||||||
//! One as [`Event::Start(element)`], one as [`Event::End(element)`].
|
//! One as [`Event::Start(element)`], one as [`Event::End(element)`].
|
||||||
//!
|
//!
|
||||||
//! [`Event::Start(element)`]: iter/enum.Event.html#variant.Start
|
//! [`Event::Start(element)`]: iter/enum.Event.html#variant.Start
|
||||||
|
@ -85,7 +85,7 @@
|
||||||
//!
|
//!
|
||||||
//! # Render html with custom HtmlHandler
|
//! # Render html with custom HtmlHandler
|
||||||
//!
|
//!
|
||||||
//! To customize html rending, simply implementing [`HtmlHandler`] trait and passing
|
//! To customize html rendering, simply implementing [`HtmlHandler`] trait and passing
|
||||||
//! it to the [`Org::html`] function.
|
//! it to the [`Org::html`] function.
|
||||||
//!
|
//!
|
||||||
//! [`HtmlHandler`]: export/html/trait.HtmlHandler.html
|
//! [`HtmlHandler`]: export/html/trait.HtmlHandler.html
|
||||||
|
|
Loading…
Reference in a new issue