From dfde25a8dc248c49d7a76f81daef3eabcb4c54df Mon Sep 17 00:00:00 2001
From: Wataru Otsubo <wotsubo@icepp.s.u-tokyo.ac.jp>
Date: Fri, 24 Jan 2025 17:39:32 +0900
Subject: [PATCH] update(doc): add example to QaqcMasterLog.parse_master_log

---
 src/QaqcMasterLog.jl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/QaqcMasterLog.jl b/src/QaqcMasterLog.jl
index 12429d4..2a68040 100644
--- a/src/QaqcMasterLog.jl
+++ b/src/QaqcMasterLog.jl
@@ -26,6 +26,14 @@ end
 
 Parse master log.
 If the `logfile` is empty, return `nothing`.
+
+# Examples
+
+```jldoctest
+julia> PSBoardDataBase.QaqcMasterLog.parse_master_log("../test/input/log/57_long.log")
+PSBoardDataBase.QaqcMasterLog.QaqcMasterLogMetadata(Dates.DateTime("2024-07-26T10:33:05"), 57, "Otsubo", v"1.0.2")
+
+```
 """
 function parse_master_log(logfile::AbstractString)
     open(logfile) do f