updateChangeLog-methods: Update ChangeLog objects

In unDocUMeantIt/roxyPackage: Utilities to Automate Package Builds

Update ChangeLog objects

Description

This method can be used to update ChangeLog objects.

Usage

updateChangeLog(log, entry, version, date = Sys.Date(), append = TRUE)

## S4 method for signature 'ChangeLog'
updateChangeLog(log, entry, version, date = Sys.Date(),
      append = TRUE)

Arguments

log	An object of class ChangeLog.
entry	A (named) list of character vectors. The element names will become the ChangeLog sections, each vector element an item.
version	Character string, version number to look up.
date	The date of the ChangeLog entry in YYYY-MM-DD format. will be coerced into character. To keep the date stamp of a present entry, set date=NULL.
append	Logical, whether a present entry should be replaced or added to.

Details

updateChangeLog takes a ChangeLog object and a version number string, replaces the complete entry with the contents of entry and updates the time stamp to date.

Value

An object of class ChangeLog.

See Also

readChangeLog

unDocUMeantIt/roxyPackage documentation built on July 26, 2024, 5:57 p.m.