Skip to content

Commit 92c1bd5

Browse files
committed
fix doc issue
1 parent 01ff804 commit 92c1bd5

6 files changed

Lines changed: 52 additions & 37 deletions

File tree

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Type: Package
22
Package: lgr
33
Title: A Fully Featured Logging Framework
4-
Version: 0.5.0
4+
Version: 0.5.1
55
Authors@R:
66
person(given = "Stefan",
77
family = "Fleck",
@@ -46,7 +46,7 @@ VignetteBuilder:
4646
knitr
4747
Encoding: UTF-8
4848
Roxygen: list(markdown = TRUE)
49-
RoxygenNote: 7.3.2
49+
RoxygenNote: 7.3.3
5050
Collate:
5151
'Filterable.R'
5252
'utils-sfmisc.R'

NEWS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# lgr 0.5.1
2+
3+
- Fix doc problem for CRAN
4+
5+
16
# lgr 0.5.0
27

38
- Added `rawMsg` property to LogEvents to store message without

R/Appender.R

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1177,15 +1177,19 @@ AppenderFileRotating <- R6::R6Class(
11771177
# AppenderFileRotatingTime ------------------------------------------------
11781178

11791179
#' Log to a time-stamped rotating file
1180+
#'
1181+
#' An extension of [AppenderFile] that rotates logfiles based on certain
1182+
#' conditions. Please refer to the documentation of [rotor::rotate_time()] for
1183+
#' the meanings of the extra arguments
1184+
#'
11801185
#' @family Appenders
11811186
#' @seealso [AppenderFileRotatingDate], [AppenderFileRotating], [rotor::rotate()]
11821187
#' @export
11831188
AppenderFileRotatingTime <- R6::R6Class(
1184-
"AppenderFileRotating",
1189+
"AppenderFileRotatingTime",
11851190
inherit = AppenderFileRotating,
11861191
public = list(
11871192

1188-
11891193
#' @description
11901194
#' @param size,age,max_backups,compression,backup_dir,fmt,overwrite,cache_backups
11911195
#' see [rotor::rotate_time()] for the meaning of these arguments. Note that
@@ -1350,6 +1354,7 @@ AppenderFileRotatingTime <- R6::R6Class(
13501354
#'
13511355
#' This is a simpler version of AppenderFileRotatingTime when the timestamps
13521356
#' do not need to include sub-day accuracy.
1357+
#'
13531358
#' @family Appenders
13541359
#' @seealso [AppenderFileRotatingTime], [AppenderFileRotating], [rotor::rotate()]
13551360
#' @export

R/Filter.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ EventFilter <- R6::R6Class(
4444
},
4545

4646
#' @description filter The `filter` method of an event must return either
47-
#' `TRUE` or `FALSE`. If it returns `TRUE`, [Filterables] such as
47+
#' `TRUE` or `FALSE`. If it returns `TRUE`, [Filterable]s such as
4848
#' [Appenders] or [Loggers] will continue processing the event, if `FALSE`
4949
#' the event will be discarded.
5050
filter = NULL

man/AppenderFileRotatingDate.Rd

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/AppenderFileRotatingTime.Rd

Lines changed: 30 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)