From 96239dd489818f4276b81fce55e2ecea638bb8ef Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Fri, 13 Sep 2024 19:29:12 +0900
Subject: [PATCH] update: docs (main index.md and docstrring)

---
 docs/src/index.md      |  7 +++++++
 src/PSBoardDataBase.jl | 20 ++++++++++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/docs/src/index.md b/docs/src/index.md
index 7de2343..6a79cb5 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -4,6 +4,8 @@ CurrentModule = PSBoardDataBase
 
 # About
 
+## API
+
 ```@index
 ```
 
@@ -11,3 +13,8 @@ CurrentModule = PSBoardDataBase
 Modules = [PSBoardDataBase]
 ```
 
+### `QaqcMasterLog`
+
+```@autodocs
+Modules = [QaqcMasterLog]
+```
diff --git a/src/PSBoardDataBase.jl b/src/PSBoardDataBase.jl
index 0865a27..624ae31 100644
--- a/src/PSBoardDataBase.jl
+++ b/src/PSBoardDataBase.jl
@@ -13,6 +13,26 @@ include("create_table.jl")
 
 include("import_data.jl")
 
+"""
+    create_database_from_exported_csvs(
+        dbpath::AbstractString;
+        single_run_csv::AbstractString,
+        runlist_csv::AbstractString,
+        dispatch_csv::AbstractString,
+        hundred_csv::AbstractString,
+        masterlog_dir::AbstractString,
+    )
+
+Create database at `dbpath` and import data from CSV and master log files.
+
+# Arguments
+- `dbpath`: where the database will be created
+- `single_run_csv`: CSV of single run results exported from the Google sheets database
+- `runlist_csv`: CSV of run lists exported from the Google sheets database
+- `dispatch_csv`: CSV of dispatch lists exported from the Google sheets database
+- `hundred_csv`: CSV of 100 tests results exported from the Google sheets database
+- `masterlog_dir`: path to the directory (`log`) where all JATHub master log is stored
+"""
 function create_database_from_exported_csvs(
     dbpath::AbstractString;
     single_run_csv::AbstractString,