From b92543afcd776649594ddfe259fd359c89991169 Mon Sep 17 00:00:00 2001
From: steven-omaha <35634100+steven-omaha@users.noreply.github.com>
Date: Wed, 15 Feb 2023 17:14:06 +0100
Subject: [PATCH] add lints, docstrings

---
 crates/pacdef_core/src/lib.rs   | 2 ++
 crates/pacdef_core/src/path.rs  | 8 ++++++++
 crates/pacdef_macros/src/lib.rs | 3 +++
 3 files changed, 13 insertions(+)

diff --git a/crates/pacdef_core/src/lib.rs b/crates/pacdef_core/src/lib.rs
index a44295c..aca6e1d 100644
--- a/crates/pacdef_core/src/lib.rs
+++ b/crates/pacdef_core/src/lib.rs
@@ -5,6 +5,8 @@ This library contains all logic that happens in `pacdef` under the hood.
 #![warn(
     clippy::as_conversions,
     clippy::cognitive_complexity,
+    clippy::missing_errors_doc,
+    clippy::missing_panics_doc,
     clippy::option_if_let_else,
     clippy::redundant_pub_crate,
     clippy::semicolon_if_nothing_returned,
diff --git a/crates/pacdef_core/src/path.rs b/crates/pacdef_core/src/path.rs
index 0124659..9891a85 100644
--- a/crates/pacdef_core/src/path.rs
+++ b/crates/pacdef_core/src/path.rs
@@ -7,6 +7,10 @@ const CONFIG_FILE_NAME: &str = "pacdef.yaml";
 
 /// Get the group directory where all group files are located. This is
 /// `$XDG_CONFIG_HOME/pacdef/groups`, which defaults to `$HOME/.config/pacdef/groups`.
+///
+/// # Errors
+///
+/// This function returns an error if both `$XDG_CONFIG_HOME` and `$HOME` are undefined.
 pub fn get_group_dir() -> Result<PathBuf> {
     let mut result = get_pacdef_base_dir().context("getting pacdef base dir")?;
     result.push("groups");
@@ -35,6 +39,10 @@ pub fn get_home_dir() -> Result<PathBuf> {
 
 /// Get the group directory where all group files are located. This is
 /// `$XDG_CONFIG_HOME/pacdef/pacdef.yaml`.
+///
+/// # Errors
+///
+/// This function returns an error if both `$XDG_CONFIG_HOME` and `$HOME` are undefined.
 pub fn get_config_path() -> Result<PathBuf> {
     let mut file = get_pacdef_base_dir().context("getting pacdef base dir for config file")?;
     file.push(CONFIG_FILE_NAME);
diff --git a/crates/pacdef_macros/src/lib.rs b/crates/pacdef_macros/src/lib.rs
index 90fd52d..705693b 100644
--- a/crates/pacdef_macros/src/lib.rs
+++ b/crates/pacdef_macros/src/lib.rs
@@ -1,9 +1,12 @@
 /*!
 Procedural macros for `pacdef`.
 */
+
 #![warn(
     clippy::as_conversions,
     clippy::cognitive_complexity,
+    clippy::missing_errors_doc,
+    clippy::missing_panics_doc,
     clippy::option_if_let_else,
     clippy::redundant_pub_crate,
     clippy::semicolon_if_nothing_returned,