summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2019-10-03 22:24:11 +0300
committerLars Wirzenius <liw@liw.fi>2019-10-03 22:24:11 +0300
commitacbdce9918d7f7c0443fd6857b79b2737d1ce9ed (patch)
treefb3b878cf920ee7162ff062980816b7002c10bf5
parent03cb997269576b902596121e2650605ef57c4385 (diff)
downloadroadmap-acbdce9918d7f7c0443fd6857b79b2737d1ce9ed.tar.gz
Change: struct Roadmap doc string
-rw-r--r--src/map.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/map.rs b/src/map.rs
index d131e7d..a89f4fc 100644
--- a/src/map.rs
+++ b/src/map.rs
@@ -4,7 +4,9 @@ pub use crate::from_yaml;
pub use crate::Status;
pub use crate::Step;
-/// All the steps to get to the end goal.
+/// Represent a full project roadmap. This stores all the steps needed
+/// to reach the end goal. See the crate leve documentation for an
+/// example.
#[derive(Clone,Debug)]
pub struct Roadmap {
steps: Vec<Step>,