Add documentation for the #date_time_new_entry helper method

This commit is contained in:
Paul van Tilburg 2016-03-06 12:17:46 +01:00
parent 49bfdff822
commit 7c41c32dfd

View file

@ -892,6 +892,14 @@ end # StopTime::Models
# = The Stop… Camping Time! helpers
module StopTime::Helpers
# Returns the date/time to use for new time entry defaults, or +nil+ if
# none is to be used. This method can use the last time entry (if any
# and if so configured). The result is based on the +date_new_entry+
# configuration option.
#
# @param last_entry [DateTime] the last time entry to use if configured
# for "previous"
# @return [DateTime, nil] the date/time to be used for new entry defaults
def date_time_new_entry(last_entry = nil)
case @config["date_new_entry"]
when "previous"