update: docs (main index.md and docstrring)

This commit is contained in:
Wataru Otsubo 2024-09-13 19:29:12 +09:00
parent 33ac8d0a34
commit 96239dd489
2 changed files with 27 additions and 0 deletions

View file

@ -4,6 +4,8 @@ CurrentModule = PSBoardDataBase
# About # About
## API
```@index ```@index
``` ```
@ -11,3 +13,8 @@ CurrentModule = PSBoardDataBase
Modules = [PSBoardDataBase] Modules = [PSBoardDataBase]
``` ```
### `QaqcMasterLog`
```@autodocs
Modules = [QaqcMasterLog]
```

View file

@ -13,6 +13,26 @@ include("create_table.jl")
include("import_data.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( function create_database_from_exported_csvs(
dbpath::AbstractString; dbpath::AbstractString;
single_run_csv::AbstractString, single_run_csv::AbstractString,