From f650706e5b227f41857771028001edb9ccb9532a Mon Sep 17 00:00:00 2001 From: Aaron Peikert Date: Mon, 12 Feb 2024 16:20:15 +0100 Subject: [PATCH 1/3] add doc string for record --- docs/src/index.md | 2 ++ src/record.jl | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index 120cf9c..5e4b93c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -56,6 +56,7 @@ Taxon ``` ```@docs +Record Taxon Factor CFA @@ -85,6 +86,7 @@ rating location(::Judgement) certainty ``` + ## Metadata ```@docs diff --git a/src/record.jl b/src/record.jl index d515e4b..657e73f 100644 --- a/src/record.jl +++ b/src/record.jl @@ -1,4 +1,5 @@ using Taxonomy + struct Record <: JudgementLevel rater::Union{AbstractString, Missing} id::Union{Base.UUID, Missing} @@ -11,6 +12,11 @@ function Record(rater, id::String, location, meta, judgements) Record(rater, Base.UUID(id), location, meta, judgements) end +""" + Record(j...; rater = missing, id = missing, location = missing, meta = missing) + +Record represents every paper(like) thing that is coded. It contains who is rating it, what is being rated (uniquely identified by an `id`), where to find it (`location`) and other metadata (usually automatically infered). +""" function Record(j...; rater = missing, id = missing, location = missing, meta = missing) if ismissing(rater) @warn "Please provide your rater ID. This should be your initials." From 72031a972fffea4d867086cf7d9d999c9694edfa Mon Sep 17 00:00:00 2001 From: Nicklas Hafiz Date: Mon, 12 Feb 2024 17:21:59 +0100 Subject: [PATCH 2/3] keep new manifest --- docs/Manifest.toml | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/Manifest.toml b/docs/Manifest.toml index bcd0bb2..a6800e3 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -1,6 +1,6 @@ # This file is machine-generated - editing it directly is not advised -julia_version = "1.8.5" +julia_version = "1.9.3" manifest_format = "2.0" project_hash = "fac757472fafdbe049b6ecdc5cdf5d2c150d7ea6" @@ -98,14 +98,14 @@ version = "1.1.0" [[deps.MbedTLS_jll]] deps = ["Artifacts", "Libdl"] uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1" -version = "2.28.0+0" +version = "2.28.2+0" [[deps.Mmap]] uuid = "a63ad114-7e13-5084-954f-fe012c677804" [[deps.MozillaCACerts_jll]] uuid = "14a3606d-f60d-562e-9121-12d972cd8159" -version = "2022.2.1" +version = "2022.10.11" [[deps.NetworkOptions]] uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" @@ -117,6 +117,12 @@ git-tree-sha1 = "0044b23da09b5608b4ecacb4e5e6c6332f833a7e" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" version = "2.3.2" +[[deps.Preferences]] +deps = ["TOML"] +git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e" +uuid = "21216c6a-2e73-6563-6e65-726566657250" +version = "1.4.1" + [[deps.Printf]] deps = ["Unicode"] uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" @@ -149,8 +155,13 @@ git-tree-sha1 = "2b5a863ee9dce57fbe3c58d000c3e981caf771fd" uuid = "78862bba-adae-4a83-bb4d-33c106177f81" version = "0.2.0" +[[deps.TOML]] +deps = ["Dates"] +uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76" +version = "1.0.3" + [[deps.Taxonomy]] -deps = ["Dates", "HTTP", "JSON", "StenoGraphs", "UUIDs"] +deps = ["Dates", "HTTP", "JSON", "Preferences", "StenoGraphs", "UUIDs"] path = ".." uuid = "fea09e6a-dc4a-42ec-a35f-5cfade855812" version = "0.1.0" @@ -180,4 +191,4 @@ uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" [[deps.Zlib_jll]] deps = ["Libdl"] uuid = "83775a58-1f1d-513f-b197-d71354ab007a" -version = "1.2.12+3" +version = "1.2.13+0" From 5951944910a70b8105610fab78b371b404edec47 Mon Sep 17 00:00:00 2001 From: Nicklas Hafiz Date: Mon, 12 Feb 2024 17:23:09 +0100 Subject: [PATCH 3/3] remove duplicated Record from index --- docs/src/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index a1aab9f..a70ce03 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -61,7 +61,6 @@ Taxon ``` ```@docs -Record Taxon ``` ### CFA