Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jubilee2 committed Dec 18, 2024
1 parent c81215d commit 810c9a1
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 22 deletions.
12 changes: 2 additions & 10 deletions man/logDetailsParseRecord.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,5 @@ print(parsed_details)
Lynne & Jubilee
}
\note{
Replaces deprecated \code{parseLogDetails()} function.
}
Details
This function splits log details into pairs using regular expressions, then iterates over pairs to extract keys and values. It handles checkboxes by converting "unchecked" and "checked" to 0 and 1, respectively.
Return Value
A list of key-value pairs, where keys are character strings and values are character strings or numeric values (for checkboxes).
Warnings
If unparseable content is encountered, a warning is issued with the problematic content.
Replacement for
\code{parseLogDetails()} (deprecated since version 0.3.0)
Replaces deprecated parseLogDetails() function.
}
10 changes: 2 additions & 8 deletions man/logDetailsParseRecordInstance.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,5 @@ print(instance_numbers)
Lynne & Jubilee
}
\note{
Replaces deprecated \code{parseLogDetailsToInstance()} function.
}
Details
This function uses regular expressions to extract instance numbers from log details. If no instance number is found, it defaults to '1'.
Return Value
A character vector of instance numbers.
Replacement for
\code{parseLogDetailsToInstance()} (deprecated since version 0.3.0)
Replaces deprecated parseLogDetailsToInstance() function.
}
4 changes: 2 additions & 2 deletions man/parseLogDetails.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ print(parsed_details)
\author{
Lynne & Jubilee
}
\deprecated{
\note{
Use \code{logDetailsParseRecord()} instead.
}
}
4 changes: 2 additions & 2 deletions man/parseLogDetailsToInstance.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ result <- logDetailsParseRecordInstance(log_details)
\author{
Lynne & Jubilee
}
\deprecated{
\note{
Use \code{logDetailsParseRecordInstance()} instead.
}
}

0 comments on commit 810c9a1

Please sign in to comment.