From 7cf2088b6fa199332ae8fe1bdfae3756abbee00e Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Thu, 3 Oct 2024 14:52:39 +0900
Subject: [PATCH] new: add docstrings for module DispatchChecker

---
 docs/src/about_software.md |  6 ++++++
 src/dispatch_checker.jl    | 25 +++++++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/docs/src/about_software.md b/docs/src/about_software.md
index c3b7470..6ebcd04 100644
--- a/docs/src/about_software.md
+++ b/docs/src/about_software.md
@@ -127,3 +127,9 @@ Modules = [DownloadCSVs]
 ```@autodocs
 Modules = [ClockParser]
 ```
+
+## `DispatchChecker`
+
+```@autodocs
+Modules = [DispatchChecker]
+```
diff --git a/src/dispatch_checker.jl b/src/dispatch_checker.jl
index 374af39..dfb627d 100644
--- a/src/dispatch_checker.jl
+++ b/src/dispatch_checker.jl
@@ -1,3 +1,8 @@
+"""
+Module to check PSBoard is dispatchable.
+
+Use [`interactive_dispatch_checker`](@ref) for interactive use in QAQC.
+"""
 module DispatchChecker
 
 using SQLite
@@ -7,6 +12,13 @@ using DataFrames
 export DbConnection
 export is_dispatchable
 
+"""
+Stores connection to database.
+
+    DbConnection(db::SQLite.DB)
+
+Constructor.
+"""
 mutable struct DbConnection
     db::SQLite.DB
     df_single_result::DataFrame
@@ -83,6 +95,14 @@ function is_dispatchable(conn::DbConnection, psbid::Int64)
     return missing
 end
 
+"""
+Interactive session for QAQC to check PSBoard is ready for dispatch.
+"""
+function interactive_dispatch_checker end
+
+"""
+    interactive_dispatch_checker(conn::DbConnection)
+"""
 function interactive_dispatch_checker(conn::DbConnection)
     dispatch_list = Int64[]
 
@@ -141,6 +161,11 @@ function interactive_dispatch_checker(conn::DbConnection)
     return dispatch_list
 end
 
+"""
+    interactive_dispatch_checker(database_file::AbstractString)
+
+Interactive session for QAQC to check provided PSBoard is ready to dispatch.
+"""
 function interactive_dispatch_checker(database_file::AbstractString)
     conn = DbConnection(SQLite.DB(database_file))
     interactive_dispatch_checker(conn)