From 4df22e617fa884f996cc2839a8287a035a999a76 Mon Sep 17 00:00:00 2001
From: sharkdp <davidpeter@web.de>
Date: Thu, 7 Feb 2019 21:24:11 +0100
Subject: [PATCH] Update documentation

---
 src/dirs.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/dirs.rs b/src/dirs.rs
index 82d32f82..e3f00ad5 100644
--- a/src/dirs.rs
+++ b/src/dirs.rs
@@ -4,9 +4,9 @@ use std::path::{Path, PathBuf};
 #[cfg(target_os = "macos")]
 use std::env;
 
-/// Wrapper for dirs that treats MacOS more like Linux.
-/// First, env variables `XDG_CACHE_HOME` and `XDG_CONFIG_HOME` are checked and the fall back is
-/// `~/.cache/bat` and `~/.config/bat`.
+/// Wrapper for 'dirs' that treats MacOS more like Linux, by following the XDG specification.
+/// This means that the `XDG_CACHE_HOME` and `XDG_CONFIG_HOME` environment variables are
+/// checked first. The fallback directories are `~/.cache/bat` and `~/.config/bat`, respectively.
 pub struct BatProjectDirs {
     cache_dir: PathBuf,
     config_dir: PathBuf,