Skip to content

Commit

Permalink
added warning regarding filenames containg dots to the help
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Fleck committed Feb 10, 2021
1 parent e802fb4 commit 6116d1a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions R/rotate.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
#' Rotate or backup files
#'
#' @description
#' Functions starting with `backup` create backups of a `file`, while functions
#' starting with `rotate` do the same but also replace the original `file`
#' with an empty one (this is useful for log rotation)
#'
#' **Note:**: `rotate()` and co will not work reliable on filenames that contain
#' dots but have no file extension (e.g. `my.holiday.picture.jpg` is OK but
#' `my.holiday.picture` is not)
#'
#'
#' @param file `character` scalar: file to backup/rotate
#'
#' @param age minimum age after which to backup/rotate a file; can be
Expand Down

0 comments on commit 6116d1a

Please sign in to comment.