#
module Puppet::Parser::Functions
newfunction(:strftime, :type => :rvalue, :doc => <<-DOC
- This function returns formatted time.
+ @summary
+ This function returns formatted time.
- Note that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this
- function. It also supports the Timestamp and Timespan data types in the Puppet language.
-
- *Examples:*
+ @return
+ converted time according to the directives in the given format string
- To return the time since epoch:
-
- strftime("%s")
+ > *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this
+ function. It also supports the Timestamp and Timespan data types in the Puppet language.
- To return the date:
+ @example **Usage**
- strftime("%Y-%m-%d")
+ To return the time since epoch: strftime("%s")
+ To return the date: strftime("%Y-%m-%d")
- *Format meaning:*
+ **Format meaning:**
%a - The abbreviated weekday name (``Sun'')
%A - The full weekday name (``Sunday'')