merge the deployment sections

README.md

@@ -197,8 +197,14 @@ See also [Friends of Rust](https://www.rust-lang.org/friends.html) (organization
   * [rr](http://rr-project.org/) — rr is a lightweight tool for recording and replaying execution of applications
 
 ### Deployment
+
 * Docker
-  * [mini-docker-rust](https://github.com/kpcyrd/mini-docker-rust) — An example project for very small rust docker images [<img src="https://travis-ci.org/kpcyrd/mini-docker-rust.svg?branch=master">](https://travis-ci.org/kpcyrd/mini-docker-rust)
+  * [emk/rust-musl-builder](https://github.com/emk/rust-musl-builder) — Docker images for compiling static Rust binaries using musl-libc and musl-gcc, with static versions of useful C libraries
+  * [kpcyrd/mini-docker-rust](https://github.com/kpcyrd/mini-docker-rust) — An example project for very small rust docker images [<img src="https://travis-ci.org/kpcyrd/mini-docker-rust.svg?branch=master">](https://travis-ci.org/kpcyrd/mini-docker-rust)
+* Google App Engine
+  * [DenisKolodin/rust-app-engine](https://github.com/DenisKolodin/rust-app-engine) — App Engine Rust boilerplate
+* Heroku
+  * [emk/heroku-buildpack-rust](https://github.com/emk/heroku-buildpack-rust) — a buildpack for Rust applications on Heroku
 
 ### Embedded
 
@@ -831,14 +837,6 @@ See also [About Rust’s Machine Learning Community](https://medium.com/@autumn_
 
 See also [Rust web framework comparison](https://github.com/flosse/rust-web-framework-comparison).
 
-
-* Deployment
-  * Docker
-    * [emk/rust-musl-builder](https://github.com/emk/rust-musl-builder) — Docker images for compiling static Rust binaries using musl-libc and musl-gcc, with static versions of useful C libraries
-  * Google App Engine
-    * [DenisKolodin/rust-app-engine](https://github.com/DenisKolodin/rust-app-engine) — App Engine Rust boilerplate
-  * Heroku
-    * [emk/heroku-buildpack-rust](https://github.com/emk/heroku-buildpack-rust) — a buildpack for Rust applications on Heroku
 * HTTP Client
   * [alexcrichton/curl-rust](https://github.com/alexcrichton/curl-rust) — [libcurl](http://curl.haxx.se/libcurl/) bindings [<img src="https://travis-ci.org/alexcrichton/curl-rust.svg?branch=master">](https://travis-ci.org/alexcrichton/curl-rust)
   * [hyperium/hyper](https://github.com/hyperium/hyper) — an HTTP implementation [<img src="https://travis-ci.org/hyperium/hyper.svg?branch=master">](https://travis-ci.org/hyperium/hyper)

src/main.rs

@@ -20,6 +20,7 @@ struct ReadmeFileContent<'a> {
     footer_markdown_events: Vec<Event<'a>>,
 }
 
+/// Creates an empty README.md file content.
 impl<'a> ReadmeFileContent<'a> {
     fn new() -> ReadmeFileContent<'a> {
         ReadmeFileContent {
@@ -44,18 +45,18 @@ enum ReadmeFileParsingState {
 /// A reference to an external resource in the README.md file.
 struct Entry {
 
-    /// The label, e.g. "rust-lang/rust" or "Servo".
+    /// The entry label, e.g. "rust-lang/rust" or "Servo".
     label: String,
 
-    /// The main URL, e.g. "https://github.com/rust-lang/rust" or "https://servo.org".
+    /// The entry's main URL, e.g. "https://github.com/rust-lang/rust" or "https://servo.org".
     url: String,
 
-    /// The description, e.g. "a modern, high-performance browser engine".
+    /// The entry description, e.g. "a modern, high-performance browser engine".
     description: String,
 }
 
 
-/// Tries to parse the README.md content string.
+/// Tries to parse the README.md file content string.
 fn parse(markdown_string: &str) -> ReadmeFileContent {
 
     // Create a Markdown parser for the README.md content string.
@@ -78,7 +79,7 @@ fn parse(markdown_string: &str) -> ReadmeFileContent {
     readme_file_content
 }
 
-
+/// Parses the README.md file header.
 fn parse_header(parser: &mut Parser, content: &mut ReadmeFileContent) -> ReadmeFileParsingState {
 
     // TODO
@@ -99,6 +100,7 @@ fn parse_header(parser: &mut Parser, content: &mut ReadmeFileContent) -> ReadmeF
     ReadmeFileParsingState::TableOfContent
 }
 
+/// Parses the README.md file table of content.
 fn parse_toc(parser: &mut Parser, content: &mut ReadmeFileContent) -> ReadmeFileParsingState {
 
     // TODO: Skip the table of content.
@@ -107,6 +109,7 @@ fn parse_toc(parser: &mut Parser, content: &mut ReadmeFileContent) -> ReadmeFile
     ReadmeFileParsingState::Content
 }
 
+/// Parses the README.md file content.
 fn parse_content(parser: &mut Parser, content: &mut ReadmeFileContent) -> ReadmeFileParsingState {
 
     // TODO
@@ -115,6 +118,7 @@ fn parse_content(parser: &mut Parser, content: &mut ReadmeFileContent) -> Readme
     ReadmeFileParsingState::Footer
 }
 
+/// Parses the README.md file footer.
 fn parse_footer<'a>(parser: &mut Parser<'a>, content: &mut ReadmeFileContent<'a>) -> ReadmeFileParsingState {
 
     // Collect the remaining Markdown events.