update(doc): SlaveLogParser

This commit is contained in:
Wataru Otsubo 2024-11-14 11:49:22 +09:00
parent 7646b29791
commit bd905ca3b7

View file

@ -1,5 +1,7 @@
""" """
Parse QAQC JATHub slave log. Parse QAQC JATHub slave log.
See [`parse_slavelog_file`](@ref) for the main function.
""" """
module SlaveLogParser module SlaveLogParser
@ -384,6 +386,9 @@ end
parse_slavelog_file(filename::AbstractString) parse_slavelog_file(filename::AbstractString)
Main function to parse slave log file. Main function to parse slave log file.
Returns `NamedTuple` with keys `adtp`, `power`, `recov` and their values are `Vector` of each results.
For a single run result, these `Vector`s have only one element and for a hundred(extra) runs, the lengths are usually 100.
For details on results for each section, see documents on dedicated types.
""" """
function parse_slavelog_file(filename::AbstractString) function parse_slavelog_file(filename::AbstractString)
lines_iter = Iterators.Stateful(eachline(filename)) lines_iter = Iterators.Stateful(eachline(filename))