X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Ftime.rb;h=d123cf68a6433dd399c7b5a449ce3571672ae34e;hp=9f2e3c8c74bb2cd96daa4f6092eb952df23c30b5;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/time.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/time.rb index 9f2e3c8c7..d123cf68a 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/time.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/time.rb @@ -3,19 +3,22 @@ # module Puppet::Parser::Functions newfunction(:time, :type => :rvalue, :doc => <<-DOC - This function will return the current time since epoch as an integer. + @summary + This function will return the current time since epoch as an integer. - *Examples:* + @return + the current time since epoch as an integer. - time() + @example **Usage** - Will return something like: 1311972653 + time() + Will return something like: 1311972653 - Note that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and + > *Note:* that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments: - Timestamp() + ```Timestamp()``` DOC ) do |arguments|