Docs & clippy improvements

Author: joepio

lib/src/agents.rs

@@ -1,4 +1,6 @@
-//! Logic for Agents - which are like Users
+//! Logic for Agents
+//! Agents are actors (such as users) that can edit content.
+//! https://docs.atomicdata.dev/commits/concepts.html
 
 use crate::{Resource, Storelike, datetime_helpers, errors::AtomicResult, urls};
 

lib/src/config.rs

@@ -1,7 +1,9 @@
 //! Configuration logic which can be used in both CLI and Server contexts
+//! For serializaing, storing, and parsing the `~/.config/atomic/config.toml` file
+
 use crate::errors::AtomicResult;
 use serde::{Deserialize, Serialize};
-use std::path::PathBuf;
+use std::path::{Path, PathBuf};
 
 /// A set of options that are shared between CLI and Server contexts
 #[derive(Debug, Serialize, Deserialize, Clone)]
@@ -29,7 +31,7 @@ pub fn default_config_file_path() -> AtomicResult<PathBuf> {
 }
 
 /// Reads config file from a specified path
-pub fn read_config(path: &PathBuf) -> AtomicResult<Config> {
+pub fn read_config(path: &Path) -> AtomicResult<Config> {
     let config_string = std::fs::read_to_string(path)
         .map_err(|e| format!("Error reading config from {:?}. {}", path, e))?;
     let config: Config = toml::from_str(&config_string)
@@ -39,7 +41,7 @@ pub fn read_config(path: &PathBuf) -> AtomicResult<Config> {
 
 /// Writes config file from a specified path
 /// Overwrites any existing config
-pub fn write_config(path: &PathBuf, config: Config) -> AtomicResult<String> {
+pub fn write_config(path: &Path, config: Config) -> AtomicResult<String> {
     let out =
         toml::to_string_pretty(&config).map_err(|e| format!("Error serializing config. {}", e))?;
     std::fs::write(path, out.clone())

lib/src/validate.rs

@@ -1,3 +1,6 @@
+//! Validate the Store and create a ValidationReport.
+//! Might be deprecated soon, as Validation hasn't been necessary since parsing has built-in data validation.
+
 /// Checks Atomic Data in the store for validity.
 /// Returns an Error if it is not valid.
 ///

server/src/main.rs

@@ -96,7 +96,7 @@ async fn main() -> AtomicResult<()> {
             // continue, start server
         }
         Some(unkown) => {
-            panic!(format!("Unkown command: {}", unkown));
+            panic!("Unkown command: {}", unkown);
         }
         None => {
             // Start server if no command is found