Skip to content

Commit 9c52c2a

Browse files
committed
Updated crate doc introduction.
Fixes #170.
1 parent 0d14526 commit 9c52c2a

File tree

2 files changed

+41
-6
lines changed

2 files changed

+41
-6
lines changed

derive/src/lib.rs

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,27 @@
99

1010
//! # pest. The Elegant Parser
1111
//!
12-
//! pest is a [PEG](https://en.wikipedia.org/wiki/Parsing_expression_grammar) parser built with
13-
//! *simplicity* and *speed* in mind.
12+
//! pest is a general purpose parser written in Rust with a focus on accessibility, correctness,
13+
//! and performance. It uses parsing expression grammars (or [PEG]) as input, which are similar in
14+
//! spirit to regular expressions, but which offer the enhanced expressivity needed to parse
15+
//! complex languages.
1416
//!
15-
//! This crate works in conjunction with the [`pest` crate](https://docs.rs/pest) by
16-
//! deriving a grammar implementation based on a provided grammar.
17+
//! [PEG]: https://en.wikipedia.org/wiki/Parsing_expression_grammar
18+
//!
19+
//! ## Getting started
20+
//!
21+
//! The recommended way to start parsing with pest is to read the official [book].
22+
//!
23+
//! Other helpful resources:
24+
//!
25+
//! * API reference on [docs.rs]
26+
//! * play with grammars and share them on our [fiddle]
27+
//! * leave feedback, ask questions, or greet us on [Gitter]
28+
//!
29+
//! [book]: https://pest-parser.github.io/book
30+
//! [docs.rs]: https://docs.rs/pest
31+
//! [fiddle]: https://pest-parser.github.io/#editor
32+
//! [Gitter]: https://gitter.im/dragostis/pest
1733
//!
1834
//! ## `.pest` files
1935
//!

pest/src/lib.rs

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,27 @@
99

1010
//! # pest. The Elegant Parser
1111
//!
12-
//! pest is a [PEG](https://en.wikipedia.org/wiki/Parsing_expression_grammar) parser built with
13-
//! *simplicity* and *speed* in mind.
12+
//! pest is a general purpose parser written in Rust with a focus on accessibility, correctness,
13+
//! and performance. It uses parsing expression grammars (or [PEG]) as input, which are similar in
14+
//! spirit to regular expressions, but which offer the enhanced expressivity needed to parse
15+
//! complex languages.
16+
//!
17+
//! [PEG]: https://en.wikipedia.org/wiki/Parsing_expression_grammar
18+
//!
19+
//! ## Getting started
20+
//!
21+
//! The recommended way to start parsing with pest is to read the official [book].
22+
//!
23+
//! Other helpful resources:
24+
//!
25+
//! * API reference on [docs.rs]
26+
//! * play with grammars and share them on our [fiddle]
27+
//! * leave feedback, ask questions, or greet us on [Gitter]
28+
//!
29+
//! [book]: https://pest-parser.github.io/book
30+
//! [docs.rs]: https://docs.rs/pest
31+
//! [fiddle]: https://pest-parser.github.io/#editor
32+
//! [Gitter]: https://gitter.im/dragostis/pest
1433
//!
1534
//! ## Usage
1635
//!

0 commit comments

Comments
 (0)