From aaca041a3eb0938ca00314aeb0ca1799d3804ba5 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Mon, 22 Oct 2018 23:47:15 +0200
Subject: Add a description to `get_trial_start()`

---
 src/trial.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src')

diff --git a/src/trial.rs b/src/trial.rs
index d8f3c2e..c37cd1f 100644
--- a/src/trial.rs
+++ b/src/trial.rs
@@ -43,6 +43,8 @@ fn initialize_trial_start() -> Result<()> {
     Ok(())
 }
 
+/// Decrypts the time string from the trial file and returns it as a
+/// `DateTime`.
 fn get_trial_start() -> Result<DateTime<FixedOffset>> {
     let xdg_dirs = xdg::BaseDirectories::with_prefix("dome-key")
         .chain_err(|| "failed to get XDG base directories")?;
-- 
cgit v1.2.3