From c122912fe82d15c7ce53359bb1a71087d1f4ab40 Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Mon, 27 Jan 2025 18:08:55 +0900
Subject: [PATCH] update(docstring): add example for create_database to provide
 recommended db/cache name

---
 src/PSBoardDataBase.jl | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/PSBoardDataBase.jl b/src/PSBoardDataBase.jl
index ca153c5..119316b 100644
--- a/src/PSBoardDataBase.jl
+++ b/src/PSBoardDataBase.jl
@@ -60,6 +60,11 @@ If you want to use alternative CSV or are not online, you can specify the path o
 - `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
 - `jathubs_csv`: CSV for jathub list used in QAQC. Used to add skew.
+
+# Examples
+```julia
+create_database("psboard_qaqc.db", masterlog_dir="test/input/log/", slavelog_dir="test/input/slavelogs/", slavelog_result="slavelog.jld2")
+```
 """
 function create_database(
     dbpath::AbstractString;