summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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>,