Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add doc string for record #142

Merged
merged 6 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ NoJudgement
rating
certainty
```

## Metadata

```@docs
Expand Down
10 changes: 5 additions & 5 deletions src/record.jl
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
"""
Record()

Build a new Record, e.g. a Paper.
"""
struct Record <: JudgementLevel
rater::Union{AbstractString, Missing}
id::Union{Base.UUID, Missing}
Expand All @@ -15,6 +10,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."
Expand Down
Loading