on master help sign in
Update documentation
commit4df22e617fa884f996cc2839a8287a035a999a76 authorsharkdp <davidpeter@web.de> dateThu 7 Feb 2019, 21:24 (8 years ago) parent6473e8c
1 file changed+3−3
src/dirs.rs+3−3
src/dirs.rs+3−3
@@ -4,9 +4,9 @@ use std::path::{Path, PathBuf};
44#[cfg(target_os = "macos")]
55use std::env;
66
7−/// Wrapper for dirs that treats MacOS more like Linux.
8−/// First, env variables `XDG_CACHE_HOME` and `XDG_CONFIG_HOME` are checked and the fall back is
9−/// `~/.cache/bat` and `~/.config/bat`.
7+/// Wrapper for 'dirs' that treats MacOS more like Linux, by following the XDG specification.
8+/// This means that the `XDG_CACHE_HOME` and `XDG_CONFIG_HOME` environment variables are
9+/// checked first. The fallback directories are `~/.cache/bat` and `~/.config/bat`, respectively.
1010pub struct BatProjectDirs {
1111 cache_dir: PathBuf,
1212 config_dir: PathBuf,