Merge pull request #553 from JakeRoggenbuck/add-docs-to-interface

Add docs on top of file
JakeRoggenbuck · Jan 23, 2024 · ed557fc · ed557fc
2 parents 211b947 + 8e1f8d4
commit ed557fc
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/interface.rs b/src/interface.rs
@@ -1,3 +1,10 @@
+///! The interface creates an API for getting and setting values with ACS
+///!
+///! Note: this is not an API for all of the functions in ACS, it's only the ones that get used in
+///! the command line tools made available in the ACS binary ('acs') and defined in src/args.rs
+///!
+///! This file offloads a lot of the work that was in src/args.rs but was too repetitive.
+///!
 use super::config::Config;
 use super::daemon::{daemon_init, Checker};
 use super::display::{