meetup_rss(description_header): Add header comment

1 files changed, 8 insertions, 0 deletions

diff --git a/src/meetup_rss.rs b/src/meetup_rss.rs
index 3445a1a..03f6823 100644
--- a/src/meetup_rss.rs
+++ b/src/meetup_rss.rs
@@ -35,6 +35,14 @@ pub fn write(channel: Channel) -> Result<()> {
 }
 
 
+/// Generates a string containing the date and venue of an `Event` for inclusion
+/// in the description field of an `rss::Item`.
+///
+/// Looks like:
+/// ``` text
+/// When: 2018-04-15 19:00
+/// Where: Passage, 99 Passage des Panoramas, Paris, France
+/// ```
 fn description_header(event: &Event) -> String {
     // let when = if let Some(date) = event.local_date &&
     //         Some(time) = event.local_time {