From 985745531cdf52f8a032fb62c754f7057fd7d312 Mon Sep 17 00:00:00 2001 From: Gambhiro Date: Sun, 15 Jan 2017 10:15:08 +0000 Subject: [PATCH] upd doc string --- src/renderer/mod.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/renderer/mod.rs b/src/renderer/mod.rs index ef348969..1054c887 100644 --- a/src/renderer/mod.rs +++ b/src/renderer/mod.rs @@ -8,9 +8,12 @@ use std::path::PathBuf; pub trait Renderer { - /// Responsible for creating an `MDBook` struct from path, preparing the - /// project and calling `render()`, doing what is necessary for the - /// particular output format. + /// When the output format is determined (by a CLI argument for example), + /// call `.build()` of the selected Renderer implementation. + /// + /// Constructs an `MDBook` struct given the path of the book project, + /// preparing the project and calling `render()`, doing what is necessary + /// for the particular output format. /// /// This involves parsing config options from `book.toml` and parsing the /// `SUMMARY.md` of each translation to a nested `Vec`.